bulma/docs
2018-04-13 15:57:10 +01:00
..
_data Fix button docs 2018-04-12 00:20:58 +01:00
_includes Add website redesign post 2018-04-13 15:00:15 +01:00
_javascript Add more link icons 2018-04-11 02:11:12 +01:00
_layouts Fix button docs 2018-04-12 00:20:58 +01:00
_posts Rename blog posts 2018-04-13 15:39:50 +01:00
_sass Add website redesign post 2018-04-13 15:00:15 +01:00
css Clean up package.json 2018-04-13 15:57:10 +01:00
documentation Fix button docs 2018-04-12 00:20:58 +01:00
favicons Update favicons 2017-01-04 19:00:50 +01:00
images Add screenshots 2018-04-12 01:02:50 +01:00
lib Add more link icons 2018-04-11 02:11:12 +01:00
vendor Add native 2018-03-29 22:25:55 +01:00
_config.yml Use docs_file 2018-04-08 12:20:07 +01:00
.babelrc Add babel 2017-07-01 18:30:39 +01:00
.gitignore Update gitignore 2018-04-13 15:46:00 +01:00
alternative-to-bootstrap.html Add more layout 2018-04-10 18:50:19 +01:00
atom.xml Add Bulma book 2018-03-26 14:46:39 +01:00
backers.html Add more layout 2018-04-10 18:50:19 +01:00
blog.html Fix button docs 2018-04-12 00:20:58 +01:00
bulma-docs.sass Anim init 2018-04-11 13:36:41 +01:00
bulma-start.html Add more layout 2018-04-10 18:50:19 +01: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
documentation.html Add documentation icons 2018-04-10 22:38:00 +01:00
expo.html Add drawings 2018-04-11 12:54:56 +01:00
extensions.html Add more layout 2018-04-10 18:50:19 +01:00
index.html Add JS 2018-04-10 15:38:50 +01:00
LICENSE Update templates 2017-01-15 21:45:20 +00:00
love.html Fix book banner 2018-04-10 23:02:30 +01:00
made-with-bulma.html Add documentation icons 2018-04-10 22:38:00 +01:00
more.html Add link element 2018-04-10 22:50:18 +01:00
package.json Clean up package.json 2018-04-13 15:57:10 +01:00
README.md Remove trailing whitespaces (#1505) 2017-12-06 23:48:35 +00:00
templates.html Organize partials 2018-04-09 22:25:26 +01:00
test.html Anim init 2018-04-11 13:36:41 +01:00
thank-you.html Organize partials 2018-04-09 22:25:26 +01:00
tiles.html Organize partials 2018-04-09 22:25:26 +01:00
yarn.lock Clean up package.json 2018-04-13 15:57:10 +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.