bulma/docs
2019-09-19 21:27:14 +01:00
..
_data Update sponsors 2019-09-11 14:12:33 +01:00
_includes Fix script 2019-09-18 19:51:16 +01: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 Update backers September 2019 2019-09-02 00:53:07 +01:00
_scripts Rename scripts folder 2019-05-18 16:11:16 +01:00
css Fix rounded buttons 2019-09-19 21:27:14 +01:00
documentation Docs: Add JavaScript filename example 2019-09-08 16:46:44 +01:00
favicons Update favicons 2017-01-04 19:00:50 +01:00
images Update Expo 2019-09-02 01:10:53 +01:00
lib Update changelog 2018-08-01 11:28:08 +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 Fix #2031, Fix #2483 2019-05-20 21:58:02 +01:00
alternative-to-bootstrap.html add Accessibility section for Bootstrap 2018-10-02 06:24:00 +01:00
atom.xml Xml Escape for Author Name 2019-01-23 22:13:52 +00:00
backers.html Update backers 2018-10-09 12:15:59 +01:00
blog.html Update backers July 2019 2019-07-09 12:20:21 +01:00
bulma-docs.sass Add home expo 2019-04-07 19:20:46 +01:00
bulma-start.html Update bulma-start 2019-02-07 19:22:21 +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
documentation.html Add documentation icons 2018-04-10 22:38:00 +01:00
expo.html Add home expo 2019-04-07 19:20:46 +01:00
extensions.html Add Bulma Dashboard to list of extensions (#2277) 2018-12-10 11:34:15 +10: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 Add link element 2018-04-10 22:50:18 +01:00
package.json Update docs for 0.7.4 2019-02-08 12:15:52 +00: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 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. 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.