mirror of
https://github.com/higherkindness/mu-haskell.git
synced 2024-08-17 02:10:22 +03:00
786 B
786 B
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: