Skip to content

Commit bd09a16

Browse files
authored
Update README.md
1 parent a1bcf55 commit bd09a16

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,13 @@ Before you start contributing, please take a moment to review our [Contribution
2222
3. **Create a PR to `main`**:
2323
After making these changes, commit them to a new branch, and then create a pull request (PR) for review from FlutterFlow team.
2424

25+
## Running the Docs Site Locally
26+
You may want to run the docs site locally to test and visualize changes you are proposing to the documentation. To run the docs site locally, please enter the following commands in the terminal of the downloaded repository:
27+
28+
1. **Install Dependencies:** Run **`npm install`** in your terminal to install the necessary dependencies.
29+
2. **Preview Changes:** To see your changes in real-time as you edit the files, you can run a local development server. This server will host your website and reflect the latest changes. Use the command **`npm run start`**.
30+
3. **Build the Website:** When you're ready, use **`npm run build`** to compile the website.
31+
2532
## Ready to Contribute?
2633
Your contributions are vital to keeping FlutterFlow's documentation clear, up-to-date, and helpful. We look forward to seeing your pull requests and are excited to welcome you into our community of contributors!
2734

@@ -43,4 +50,4 @@ Your contributions are vital to keeping FlutterFlow's documentation clear, up-to
4350
[//]: # (repo: 'documentation')
4451

4552
[//]: # (})")
46-
If you have any questions or need further guidance, don't hesitate to reach out to the documentation team. Happy documenting!
53+
If you have any questions or need further guidance, don't hesitate to reach out to the documentation team. Happy documenting!

0 commit comments

Comments
 (0)