PhysLean/docs/WebsiteInstructions.md

20 lines
641 B
Markdown
Raw Normal View History

2025-02-14 08:56:51 +00:00
# PhysLean website
2025-02-14 08:56:51 +00:00
The PhysLean 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:
2025-02-14 08:56:51 +00:00
- navigate your terminal to the `./docs` directory of PhysLean using e.g. `cd ./docs`.
- Run `bundle exec jekyll serve`
- Open `http://localhost:4000` in your webbrowser.
2025-02-14 08:56:51 +00:00
## PhysLean domain
2025-02-14 08:56:51 +00:00
The PhysLean website is hosted at `https://heplean.com`. This domain is registered via
squarespace domains by Joseph Tooby-Smith.