mirror of
https://github.com/hendricius/the-sourdough-framework
synced 2025-11-10 05:01:11 -06:00
50d65f693b
This improves the documentation on how to build the website and applies a couple of additional fixes. Followup to #161
23 lines
619 B
Markdown
23 lines
619 B
Markdown
# The Sourdough Framework website
|
|
This code is responsible to generate the sourdough framework website.
|
|
|
|
You can preview the website at [https://www.the-sourdough-framework.com](https://www.the-sourdough-framework.com/).
|
|
|
|
## Installation
|
|
|
|
Make sure you have ruby installed. The same version as listed in the `.ruby-version` file.
|
|
|
|
## Building the website
|
|
|
|
Go to the `../book` folder and run `make website`.
|
|
|
|
If you want to run the post-processor only, run the processing script with:
|
|
|
|
```bash
|
|
bundle exec ruby modify_build.rb
|
|
```
|
|
|
|
## Viewing the website
|
|
|
|
Go to the `static_website_html` folder and view the HTML files.
|