bulma/docs
Jeremy Thomas 524bb3cdf2 Fix links
2020-09-09 20:37:10 +01:00
..
_data Fix links 2020-09-09 20:37:10 +01:00
_includes Update backers September 2020 2020-09-03 11:52:37 +02:00
_javascript Customizing spacing helpers output 2020-05-17 13:47:06 +01:00
_layouts Add keywords inclusion tests 2020-08-08 17:16:04 +01:00
_posts Fix documentation links 2020-06-08 10:57:35 +01:00
_sass Customizing spacing helpers output 2020-05-17 13:47:06 +01:00
_scripts Rename scripts folder 2019-05-18 16:11:16 +01:00
css Deploy docs 2020-08-08 17:29:34 +01:00
documentation Fix #3020: Add spacing helpers for all sides 2020-08-27 11:46:39 +02:00
favicons Update favicons 2017-01-04 19:00:50 +01:00
images Fix missing avatar 2020-09-03 12:17:03 +02:00
lib Customizing spacing helpers output 2020-05-17 13:47:06 +01:00
vendor Add native 2018-03-29 22:25:55 +01:00
_config.yml Launch 0.9.0 2020-06-07 14:15:06 +01:00
.babelrc Add babel 2017-07-01 18:30:39 +01:00
.gitignore fix: documentation button hidden on tablets 2019-10-17 11:49:01 +01:00
alternative-to-bootstrap.html Fix documentation links 2020-06-08 10:57:35 +01:00
atom.xml Xml Escape for Author Name 2019-01-23 22:13:52 +00:00
backers.html Update backers September 2020 2020-09-03 11:52:37 +02:00
blog.html Launch 0.9.0 2020-06-07 14:15:06 +01:00
bulma-dark.sass Add more color documentation, Add light buttons to docs 2019-10-17 20:51:42 -04:00
bulma-docs.sass Update sponsors 2020-03-23 12:15:29 +00:00
bulma-start.html Update bulma-start.html 2020-07-16 14:05:27 +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 Fix share URL 2019-10-18 07:43:14 -04:00
extensions.html Update extensions.html 2020-08-05 18:00:36 +01:00
index.html Add Boosta 2019-07-18 10:56:18 +02:00
LICENSE Update templates 2017-01-15 21:45:20 +00:00
love.html Fix tw element 2019-04-07 16:28:01 +01:00
made-with-bulma.html Add documentation icons 2018-04-10 22:38:00 +01:00
more.html Launch 0.9.0 2020-06-07 14:15:06 +01:00
package-lock.json Uprade dependencies 2020-04-11 13:14:21 +01:00
package.json Uprade dependencies 2020-04-11 13:14:21 +01:00
README.md Add tip to open local server URL after build 2019-03-05 12:13:39 +01: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 Deploy docs 2020-08-08 17:29:34 +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. You can also add the --open-url option (or its alias --o) to automatically open the server URL in your default browser when it's ready.

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