mirror of
https://github.com/jgthms/bulma
synced 2026-03-15 02:04:29 -07:00
afcdb7dbcc
* Update navbar variables in component docs page * Update pagination variables in component docs page * Update tabs variables in component docs page * Update button variables in element docs page * Update table variables in element docs page * Update title variables in element docs page * Update variables template to support layout * Add section variables in relevant docs page * Add footer variables in relevant docs page * Update variables template to support custom messages * Add form generic variables in relevant docs page * Update derived variables in relevant docs page * Add generic variables to variables docs page * Update sass files count in docs Modular page
Building the documentation
The documentation HTML is produced with the Ruby-based jekyll tool.
- Make sure Ruby 2.x is installed.
gem install jekyll
Viewing the documentation locally
Then to view the documentation in your local checkout:
- Before you begin, cd into
docs/directory, andcp _config.yml _config.local.yml. Then edit_config.local.ymland change theurl:value tohttp://localhost:4000. This local config file will be ignored by git. - In a separate shell session,
cdto thedocs/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.
2. 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.