mirror of
https://github.com/jgthms/bulma.git
synced 2024-11-14 11:14:24 +00:00
28 lines
1.3 KiB
Markdown
28 lines
1.3 KiB
Markdown
## Building the documentation
|
|
|
|
The documentation HTML is produced with the Ruby-based `jekyll` tool.
|
|
|
|
1. Make sure Ruby 2.x is installed.
|
|
2. `gem install jekyll` if `jekyll` is not already installed.
|
|
|
|
> **Note**: If you are an ```Ubuntu user```, make sure ruby2.x-dev is installed.
|
|
|
|
## Viewing the documentation locally
|
|
|
|
To view the documentation on your system locally:
|
|
|
|
### Setup
|
|
|
|
1. `cd` into `docs/` directory
|
|
1. Copy the config file, `cp _config.yml _config.local.yml`
|
|
1. Edit `_config.local.yml` and change the `url:` value to `http://localhost:4000`. This local config file will be ignored by git.
|
|
|
|
### Run Jekyll
|
|
|
|
1. In a separate shell session, `cd` to the `docs/` directory, and do:
|
|
```
|
|
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-docs` 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.
|