bulma/docs
2018-10-28 09:04:43 +00:00
..
_data Update expo October 2018 2018-10-16 16:31:16 +01:00
_includes Fix variables component, Fix doc tabs 2018-10-28 08:57:38 +00:00
_javascript Fixed docs when Vimeo fails to load 2018-07-18 22:08:23 +01:00
_layouts Add documentation tabs 2018-07-12 17:15:30 +01:00
_posts Fix relative links 2018-10-12 11:23:32 +01:00
_sass Fix variables component, Fix doc tabs 2018-10-28 08:57:38 +00:00
css Fix variables component, Fix doc tabs 2018-10-28 08:57:38 +00:00
documentation Makes is-full-height-with-navbar samples match 2018-10-28 09:04:43 +00:00
favicons Update favicons 2017-01-04 19:00:50 +01:00
images Update expo October 2018 2018-10-16 16:31:16 +01:00
lib Update changelog 2018-08-01 11:28:08 +01:00
scripts Fix variables component 2018-06-20 01:21:22 +01:00
vendor Add native 2018-03-29 22:25:55 +01:00
_config.yml Website 0.7.0 2018-04-13 16:45:12 +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 Accessibility section for Bootstrap 2018-10-02 06:24:00 +01:00
atom.xml Add Bulma book 2018-03-26 14:46:39 +01:00
backers.html Update backers 2018-10-09 12:15:59 +01:00
blog.html Fix button docs 2018-04-12 00:20:58 +01:00
bulma-docs.sass Add documentation tabs 2018-07-12 17:15:30 +01:00
bulma-start.html bulma-start better 'getting started' (#2147) 2018-10-15 16:22:13 +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 Update expo October 2018 2018-10-16 16:31:16 +01:00
extensions.html Update bulma toast link 2018-10-25 10:48:37 +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 Update variables include template 2018-06-20 01:21:22 +01:00
README.md Improve clarity in docs/readme (#2066) 2018-10-07 18:32:03 +02:00
templates.html Organize partials 2018-04-09 22:25:26 +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
videos.html Fix relative links 2018-10-12 11:23:32 +01:00
yarn.lock Update variables include template 2018-06-20 01:21:22 +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 if jekyll is not already installed.

Note

: If you are an Ubuntu user, make sure ruby2.x-dev is installed.

Viewing the documentation locally

To view the documentation on your system locally:

Setup

  1. cd into docs/ directory
  2. Copy the config file, cp _config.yml _config.local.yml
  3. Edit _config.local.yml and change the url: value to http://localhost:4000. This local config file will be ignored by git.

Run Jekyll

  1. 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. 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.