bulma/docs
Jeremy Thomas 74c01f42d1 Fix #3830
2024-06-23 23:35:32 +01:00
..
_data Fix #3823 2024-06-23 22:56:35 +01:00
_includes Add cookie banner 2024-06-11 15:09:59 +01:00
_layouts Init shop 2024-06-10 23:20:16 +01:00
_posts Fix website transfer includes 2024-03-21 16:39:38 +00:00
_sass Add cookie banner 2024-06-11 15:09:59 +01:00
_scripts Init v1 2024-03-21 16:11:54 +00:00
assets Add cookie banner 2024-06-11 15:09:59 +01:00
cyp Setup cypress (#3436) 2022-05-08 13:55:16 +01:00
cypress Update dependencies 2022-11-23 17:09:26 +00:00
documentation Fix #3830 2024-06-23 23:35:32 +01:00
favicons Update favicons 2017-01-04 19:00:50 +01:00
library Init v1 2024-03-21 16:11:54 +00:00
vendor Update to Font Awesome 6 2024-04-17 14:16:12 +01:00
_config.yml Init v1 2024-03-21 16:11:54 +00:00
.babelrc Add babel 2017-07-01 18:30:39 +01:00
.gitignore Fix #3747 2024-04-29 12:49:22 +01:00
.prettierignore Init v1 2024-03-21 16:11:54 +00:00
.prettierrc Init v1 2024-03-21 16:11:54 +00:00
alternative-to-bootstrap.html Fix website transfer includes 2024-03-21 16:39:38 +00:00
atom.xml Xml Escape for Author Name 2019-01-23 22:13:52 +00:00
backers-md.html Fix website transfer includes 2024-03-21 16:39:38 +00:00
backers.html Add backers 2024-03-21 17:19:44 +00:00
become-a-bulma-sponsor.html Init v1 2024-03-21 16:11:54 +00:00
blog.html Fix website transfer includes 2024-03-21 16:39:38 +00:00
brand.html Init v1 2024-03-21 16:11:54 +00:00
bulma-start.html Fix website transfer includes 2024-03-21 16:39:38 +00:00
bulma-templates.html Init v1 2024-03-21 16:11:54 +00:00
CNAME Create CNAME 2016-09-11 14:32:11 +01:00
cypress.config.js Update dependencies 2022-11-23 17:09:26 +00:00
docker-compose.yml docker-compose file 2017-04-01 13:39:17 +01:00
documentation.html Switch to Font Awesome 5 2024-03-23 19:25:09 +00:00
expo.html Init v1 2024-03-21 16:11:54 +00:00
extensions.html Init v1 2024-03-21 16:11:54 +00:00
index.html Init v1 2024-03-21 16:11:54 +00:00
LICENSE Update templates 2017-01-15 21:45:20 +00:00
love.html Init v1 2024-03-21 16:11:54 +00:00
made-with-bulma.html Init v1 2024-03-21 16:11:54 +00:00
more.html Fix website transfer includes 2024-03-21 16:39:38 +00:00
package-lock.json Init v1 2024-03-21 16:11:54 +00:00
package.json Build 1.0.1 2024-05-20 17:38:07 +01:00
README.md Add tip to open local server URL after build 2019-03-05 12:13:39 +01:00
shop.html Add cookie banner 2024-06-11 15:09:59 +01:00
templates.html Organize partials 2018-04-09 22:25:26 +01:00
thank-you.html Fix website transfer includes 2024-03-21 16:39:38 +00:00
the-official-bulma-book.html Fix website transfer includes 2024-03-21 16:39:38 +00:00
videos.html Fix website transfer includes 2024-03-21 16:39:38 +00:00
website.scss Adjust shop styling 2024-06-11 12:42:21 +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.