PhysLean/docs/WebsiteInstructions.md
Joseph Tooby-Smith 7b396501e7
docs: Update website (#288)
* Create WebsiteInstructions.md

* Update index.markdown
2025-01-22 07:46:47 +00:00

19 lines
636 B
Markdown

# HepLean website
The HepLean website is made using [Jeykll](https://jekyllrb.com) and is generated via the workflow
`./.github/docs.yml`.
## Hosting the website locally
The installation instructions for jekyll can be found [here](https://jekyllrb.com/docs/installation/#requirements).
Once jekyll is installed:
- navigate your terminal to the `./docs` directory of HepLean using e.g. `cd ./docs`.
- Run `bundle exec jekyll serve`
- Open `http://localhost:4000` in your webbrowser.
## HepLean domain
The HepLean website is hosted at `https://heplean.com`. This domain is registered via
squarespace domains by Joseph Tooby-Smith.