bulma/docs
2017-11-06 12:51:20 +00:00
..
_data Update twitter profile photo. (#1387) 2017-11-04 19:47:11 +00:00
_includes Add top bottom navbar toggle 2017-11-06 12:51:20 +00:00
_javascript Add top bottom navbar toggle 2017-11-06 12:51:20 +00:00
_layouts Add top bottom navbar toggle 2017-11-06 12:51:20 +00:00
_posts Use https for Bulma 2017-10-16 13:31:27 +01:00
_sass Fix navbar link color 2017-11-06 12:51:20 +00:00
css Fix navbar link color 2017-11-06 12:51:20 +00:00
documentation Fix navbar link color 2017-11-06 12:51:20 +00:00
favicons Update favicons 2017-01-04 19:00:50 +01:00
images Add bulma start 2017-10-17 14:06:45 +01:00
lib Add top bottom navbar toggle 2017-11-06 12:51:20 +00:00
vendor Update expo 2017-10-09 10:04:12 +01:00
_config.yml Use https for Bulma 2017-10-16 13:31:27 +01:00
.babelrc Add babel 2017-07-01 18:30:39 +01:00
.gitignore Remove docs css map 2017-10-10 10:56:18 +01:00
alternative-to-bootstrap.html Add bd classes 2017-08-14 13:01:07 +01:00
atom.xml Move docs to bulma repo (#299) 2016-09-11 12:00:49 +01:00
blog.html Add bd classes 2017-08-14 13:01:07 +01:00
bulma-docs.sass Create snippet component 2017-09-01 10:16:16 +02:00
bulma-start.html Fix the last link under npm dependencies (#1400) 2017-11-01 21:24:31 +00:00
CNAME Create CNAME 2016-09-11 14:32:11 +01:00
docker-compose.yml docker-compose file 2017-04-01 13:39:17 +01:00
expo.html Update expo 2017-10-09 10:04:12 +01:00
extensions.html Use link instead of primary 2017-10-10 10:50:00 +01:00
index.html Add top bottom navbar toggle 2017-11-06 12:51:20 +00:00
LICENSE Update templates 2017-01-15 21:45:20 +00:00
love.html Use https twitter images 2017-10-16 13:31:27 +01:00
made-with-bulma.html Docs/variables data (#1314) 2017-10-17 10:28:59 +01:00
package.json Add babel 2017-07-01 18:30:39 +01:00
README.md Fixes #560: Adds how-to README for docs (#561) 2017-03-14 22:23:57 +00:00
templates.html Fix button spacing, Add image placeholders 2016-12-22 18:17:26 +00:00
thank-you.html Add heading 2017-07-29 18:24:07 +01:00
tiles.html Create snippet component 2017-09-01 10:16:16 +02:00
yarn.lock Add babel 2017-07-01 18:30:39 +01:00

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

Viewing the documentation locally

Then to view the documentation in your local checkout:

  1. Before you begin, cd into docs/ directory, and cp _config.yml _config.local.yml. Then edit _config.local.yml and change the url: value to http://localhost:4000. This local config file will be ignored by git.
  2. 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. 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.