mirror of
https://github.com/hendricius/the-sourdough-framework
synced 2025-11-08 12:11:11 -06:00
Improve website build documentation (#162)
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:
committed by
GitHub
parent
a8ad6f0a8b
commit
50d65f693b
2
.github/workflows/release-website.yml
vendored
2
.github/workflows/release-website.yml
vendored
@@ -31,7 +31,7 @@ jobs:
|
||||
image: ghcr.io/hendricius/the-sourdough-framework:latest
|
||||
options: -v ${{ github.workspace }}:/app
|
||||
run: |
|
||||
cd /app/website
|
||||
cd /app/book
|
||||
make website
|
||||
- name: Release baked website to S3
|
||||
uses: shallwefootball/s3-upload-action@master
|
||||
|
||||
4
makefile
4
makefile
@@ -18,10 +18,6 @@ push_docker_image:
|
||||
|
||||
.PHONY: website
|
||||
website: mrproper
|
||||
docker run -it -v $(PWD):/opt/repo $(DOCKER_IMAGE) /bin/bash -c "cd /opt/repo/website && make website"
|
||||
|
||||
.PHONY: latex_website
|
||||
latex_website: mrproper
|
||||
docker run -it -v $(PWD):/opt/repo $(DOCKER_IMAGE) /bin/bash -c "cd /opt/repo/book && make website"
|
||||
|
||||
.PHONY: validate
|
||||
|
||||
22
website/README.md
Normal file
22
website/README.md
Normal 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.
|
||||
Reference in New Issue
Block a user