From 2902f6b1062c968cdf2fd51bf599d92eb96ba76b Mon Sep 17 00:00:00 2001 From: jp06 Date: Tue, 5 Mar 2019 17:30:54 +0800 Subject: [PATCH] Add tip to open local server URL after build --- docs/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 11bfb710e..2e6b52268 100644 --- a/docs/README.md +++ b/docs/README.md @@ -24,4 +24,6 @@ To view the documentation on your system locally: jekyll serve --incremental --config _config.local.yml ``` -This will start an HTTP server at `http://localhost:4000/` that serves the docs built in the `_site` directory; and anytime the docs are rebuilt by you, it will serve the docs site on the fly. In your main shell session where you develop, if you change anything in `docs/` the jekyll server will rebuild those on the fly. But if you change anything about the Bulma SASS or CSS, you need to do `npm run start` to build the docs' CSS before you will see it in the browser. The process running `jekyll serve` will pick up the new CSS automatically. +This will start an HTTP server at `http://localhost:4000/` that serves the docs built in the `_site` directory; and anytime the docs are rebuilt by you, it will serve the docs site on the fly. You can also add the `--open-url` option (or its alias `--o`) to automatically open the server URL in your default browser when it's ready. + +In your main shell session where you develop, if you change anything in `docs/` the jekyll server will rebuild those on the fly. But if you change anything about the Bulma SASS or CSS, you need to do `npm run start` to build the docs' CSS before you will see it in the browser. The process running `jekyll serve` will pick up the new CSS automatically. -- 2.47.2