bulma/docs
2023-11-29 21:06:43 +00:00
..
_data Update logo size 2023-11-29 21:06:43 +00:00
_includes Update July 2023 2023-07-03 16:41:28 +01:00
_javascript Fix #3461 2022-01-16 00:00:43 +00:00
_layouts Update June 2022 2022-06-03 11:45:26 +02:00
_posts Fix typo in 2019-10-15-light-dark-colors.md 2021-04-04 07:33:21 +01:00
_sass Update December 2022 2022-12-01 19:02:29 +00:00
_scripts Bulma v9 website (#3249) 2021-01-27 23:30:42 +00:00
assets Fix #3461 2022-01-16 00:00:43 +00:00
css Update December 2022 2022-12-01 19:02:29 +00: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 removed deprecated code 2023-07-18 17:07:03 +04:00
favicons Update favicons 2017-01-04 19:00:50 +01:00
images Update logo size 2023-11-29 21:06:43 +00:00
lib Fix #3461 2022-01-16 00:00:43 +00:00
playground Add responsive button sizes (#3484) 2022-02-06 15:57:04 +00:00
vendor Bulma v9 website (#3249) 2021-01-27 23:30:42 +00: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 Update January 2022 2022-01-04 11:59:58 +01:00
alternative-to-bootstrap.html Bulma v9 website (#3249) 2021-01-27 23:30:42 +00:00
atom.xml Xml Escape for Author Name 2019-01-23 22:13:52 +00:00
backers-md.html Update December 2021 2021-12-03 12:41:07 +00:00
backers.html Bulma v9 website (#3249) 2021-01-27 23:30:42 +00:00
become-a-bulma-sponsor.html Bulma v9 website (#3249) 2021-01-27 23:30:42 +00:00
blog.html Bulma v9 website (#3249) 2021-01-27 23:30:42 +00:00
brand.html Add link 2022-01-16 00:21:15 +00:00
bulma-dark.sass Add more color documentation, Add light buttons to docs 2019-10-17 20:51:42 -04:00
bulma-docs.scss Add love sorting 2022-02-03 12:51:38 +00:00
bulma-start.html 3500 fix ios bug (#3521) 2022-05-07 12:10:40 +01:00
bulma.scss Setup cypress (#3436) 2022-05-08 13:55:16 +01: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 Add documentation icons 2018-04-10 22:38:00 +01:00
expo.html Update Expo 2023-08-18 18:42:17 +02:00
extensions.html Add bulma-jumbo-tiny to list of extensions 2023-04-23 22:49:19 +01:00
index.html Bulma v9 website (#3249) 2021-01-27 23:30:42 +00:00
LICENSE Update templates 2017-01-15 21:45:20 +00:00
love.html Add love sorting 2022-02-03 12:51:38 +00:00
made-with-bulma.html Bulma v9 website (#3249) 2021-01-27 23:30:42 +00:00
more.html Bulma v9 website (#3249) 2021-01-27 23:30:42 +00:00
package-lock.json Update packages 2023-04-03 10:45:04 +01:00
package.json Update packages 2023-04-03 10:45:04 +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
the-official-bulma-book.html Bulma v9 website (#3249) 2021-01-27 23:30:42 +00:00
tiles.html Organize partials 2018-04-09 22:25:26 +01:00
videos.html Bulma v9 website (#3249) 2021-01-27 23:30:42 +00: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.