bulma/docs
2018-04-08 14:38:59 +01:00
..
_data Update backers March 2018 2018-04-02 23:29:59 +01:00
_includes Use docs_file 2018-04-08 12:20:07 +01:00
_javascript Add cookie expiration date 2018-03-28 09:10:39 +01:00
_layouts Better placement 2018-03-29 22:53:26 +01:00
_posts Correct typo : "Bulima" to "Bulma (#1614) 2018-01-19 11:35:49 +00:00
_sass Fix spacing 2018-04-04 15:00:45 +01:00
css Add bulma docs minified CSS 2018-04-08 13:42:39 +01:00
documentation Fix mergeColorMaps 2018-04-08 14:38:59 +01:00
favicons Update favicons 2017-01-04 19:00:50 +01:00
images Add tooltwist 2018-04-03 22:22:02 +01:00
lib Add cookie expiration date 2018-03-28 09:10:39 +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 Fix #1456 2017-12-04 19:28:07 +00:00
alternative-to-bootstrap.html Add Bulma book 2018-03-26 14:46:39 +01:00
atom.xml Add Bulma book 2018-03-26 14:46:39 +01:00
backers.html Update backers March 2018 2018-04-02 23:29:59 +01:00
blog.html Better placement 2018-03-29 22:53:26 +01:00
bulma-docs.sass Fix mergeColorMaps 2018-04-08 14:38:59 +01: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 Update expo 2018-03-26 11:29:29 +01:00
extensions.html Update moreDropdown 2018-01-18 15:43:10 +00:00
index.html Add tooltwist 2018-04-03 22:22:02 +01: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 new newsletter form 2018-01-19 16:54:05 +00: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.