You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@royale.apache.org by ha...@apache.org on 2020/08/17 09:28:35 UTC

[royale-docs] 03/04: Updated readme for more info on local builds

This is an automated email from the ASF dual-hosted git repository.

harbs pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/royale-docs.git

commit c950465e6066a34de6e18f8427fa132f9095bc95
Author: Harbs <ha...@in-tools.com>
AuthorDate: Mon Aug 17 11:48:20 2020 +0300

    Updated readme for more info on local builds
---
 README.md | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 7eab2b5..00cc5e4 100644
--- a/README.md
+++ b/README.md
@@ -86,7 +86,7 @@ Search is done thanks to [Algolia DocSearch](https://community.algolia.com/docse
 4. To build the docs, run the following command:
 
     ```sh
-    jekyll build --config local_config.yml
+    jekyll build --watch --config _config.yml
     ```
     
     The website will be rendered inside the `_site` folder.
@@ -95,5 +95,10 @@ Search is done thanks to [Algolia DocSearch](https://community.algolia.com/docse
    ```sh
    jekyll serve
    ```
-   
+   You might need the following for automatic regeneration:
+
+   ```sh
+   jekyll serve --force_polling
+   ```
+
    The website will be available at `http://127.0.0.1:4000/royale-docs/`.