mirror of
https://github.com/jgthms/bulma.git
synced 2024-11-14 11:14:24 +00:00
c7c1a99afa
* Addition of Sass Color Map to Customize Page Added verbiage to Customization page to demonstrate how to add new colors to the color map. Using this methodology allows for the dev to use `<i class="fa fa-github has-text-github"></i>` or use `is-github` in a class for a background. * Change map-merge of $color to only merge once, Sass Complience - Changed map-merge of $color to import from another map rather than adding each line individually. - Made it Sass Compliant Updating based on #1394 comments from @jgthms |
||
|---|---|---|
| .. | ||
| _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 | ||
| bulma-start.html | ||
| 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.