Skip to content

Note new 404 page in README.md #97

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 6, 2025
Merged

Note new 404 page in README.md #97

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a82b109
Note new 404 page in README.md
rlanzafame Aug 5, 2025
3226fb5
Add versioning info
Tom-van-Woudenberg Aug 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ If you have an organization for your TeachBook on GitHub, link your GitHub team
- Customizable settings on where the books should be deployed including alias for branch-names and selection of one branch to be deployed on root. The workflow will gives warnings if these settings are ill-defined or conflicting. Although aliases are generally not allowed by GitHub Pages, it seems you can use one alias, but not more.
- Customizable behavior of book URL root directory, either by redirecting the root to one of the branches or by copying or moving one of the branches to root.
- Adds an 'archived'-banner to old branches / branches of previous years.
- Custom 404 "Page Not Found" page with buttons for redirecting to Homepage (e.g., book intro page), "Go Back" or Repository home.
- Semantic ersioning: tags used for major, minor and patch version. `main` contains most up to date version. Branch `v1` contains the most recent version `1.x.x`.

## How to start using this workflow
As previously mentioned, this workflow is used in `TeachBooks/template`. Feel free to use it for your TeachBook as well:
Expand Down