mirror of
https://github.com/higherkindness/mu-haskell.git
synced 2024-10-26 15:49:00 +03:00
3d9aff4502
This reverts commit
|
||
---|---|---|
.. | ||
_data | ||
_includes | ||
_layouts | ||
_sass | ||
css | ||
docs | ||
img | ||
js | ||
_config.yml | ||
Gemfile | ||
Gemfile.lock | ||
README.md |
Docs for Mu-Haskell
The documentation is built through a Jekyll site as base.
Prerequisites
- You need to have ruby >= 2.4.0 installed on your system.
- Bundler >= 2 is also needed.
Building the docs
To preview the site locally, execute the following command from the project root dir. This will install website dependencies under docs/vendor/bundle
:
bundle install --gemfile docs/Gemfile --path vendor/bundle
Then, through this command, you will run the locally installed Jekyll instance to serve the site:
BUNDLE_GEMFILE=./docs/Gemfile bundle exec jekyll serve -s docs -b /mu-haskell
Finally, to have a look at the site, visit: