mirror of
https://github.com/jgthms/bulma.git
synced 2024-11-14 11:14:24 +00:00
1523ce8527
* Replace variables.json with colors.json and update related files accordingly * Add variables data files * Update variables include template and all related files to use new variables data * Fix mobile breakpoint id typo in responsivness docs page * Fix Liquid syntax error in made-with-bulma docs page * Update bulma sass files count in modular docs page * Use breakpoints data in responsiveness helpers docs page * Use breakpoints and variables data in typography helpers docs page * Add missing page titles in docs pages front matter |
||
|---|---|---|
| .. | ||
| _data | ||
| _includes | ||
| _javascript | ||
| _layouts | ||
| _posts | ||
| _sass | ||
| css | ||
| documentation | ||
| favicons | ||
| images | ||
| lib | ||
| vendor | ||
| _config.yml | ||
| .babelrc | ||
| .gitignore | ||
| alternative-to-bootstrap.html | ||
| atom.xml | ||
| blog.html | ||
| bulma-docs.sass | ||
| CNAME | ||
| docker-compose.yml | ||
| expo.html | ||
| extensions.html | ||
| index.html | ||
| LICENSE | ||
| love.html | ||
| made-with-bulma.html | ||
| package.json | ||
| README.md | ||
| templates.html | ||
| thank-you.html | ||
| tiles.html | ||
| yarn.lock | ||
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.