bulma/docs
2018-01-18 16:59:05 +00:00
..
_data Use full length tweets 2018-01-18 13:29:11 +00:00
_includes Update moreDropdown 2018-01-18 15:43:10 +00:00
_javascript Use Font Awesome 5 2018-01-10 16:30:23 +00:00
_layouts Add Font Awesome 5 blog post 2018-01-18 16:59:05 +00:00
_posts Add Font Awesome 5 blog post 2018-01-18 16:59:05 +00:00
_sass Update moreDropdown 2018-01-18 15:43:10 +00:00
css Update moreDropdown 2018-01-18 15:43:10 +00:00
documentation Update moreDropdown 2018-01-18 15:43:10 +00:00
favicons Update favicons 2017-01-04 19:00:50 +01:00
images Add favicon.ico 2018-01-16 18:52:49 +01:00
lib Fix Safari momentum translation 2017-11-07 14:03:21 +00:00
vendor Update expo 2017-10-09 10:04:12 +01:00
_config.yml Use 0.6.2 2018-01-10 17:53:22 +00:00
.babelrc Add babel 2017-07-01 18:30:39 +01:00
.gitignore Fix #1456 2017-12-04 19:28:07 +00:00
alternative-to-bootstrap.html Use Font Awesome 5 2018-01-10 16:30:23 +00:00
atom.xml Make feed entries show full content (#1577) 2018-01-06 22:27:53 +00:00
backers.html Update backers 2017-12-04 13:04:28 +00:00
blog.html Use Font Awesome 5 2018-01-10 16:30:23 +00:00
bulma-docs.sass Add fortyfour 2018-01-10 11:48:03 +00:00
bulma-start.html Add scroll reveal 2017-11-06 12:51:20 +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 Add favicon.ico 2018-01-16 18:52:49 +01:00
extensions.html Update moreDropdown 2018-01-18 15:43:10 +00:00
index.html Use Font Awesome 5 2018-01-10 16:30:23 +00:00
LICENSE Update templates 2017-01-15 21:45:20 +00:00
love.html Use tweet ids 2018-01-16 18:38:32 +01:00
made-with-bulma.html Add scroll reveal 2017-11-06 12:51:20 +00:00
package.json Use 0.6.2 2018-01-10 17:53:22 +00:00
README.md Remove trailing whitespaces (#1505) 2017-12-06 23:48:35 +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.