mchapman/the-sourdough-framework
1
0
Fork 0
mirror of https://github.com/hendricius/the-sourdough-framework synced 2026-02-11 16:57:14 -06:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve website build documentation (#162)

Browse Source 
This improves the documentation on how to build the website and applies
a couple of additional fixes. Followup to #161
This commit is contained in:
Hendrik Kleinwaechter
2023-08-04 16:14:05 +02:00
committed by GitHub
parent a8ad6f0a8b
commit 50d65f693b
3 changed files with 23 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
website/README.md Normal file
View File

@@ -0,0 +1,22 @@
# 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.