Skip to content

Commit

Permalink
Add usage guide
Browse files Browse the repository at this point in the history
  • Loading branch information
TechnicJelle authored Sep 20, 2024
1 parent c5ad3b0 commit afbf400
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
<img align="left" src=".github/readme_assets/icon.png" alt="logo">

# Simple Custom SSG Template
A simple Python template to start building a static site generator from.
This is a template project that you can use as a base for your own website,
generated by your own custom Static Site Generator, with Python.

Designed to be hosted on GitHub Pages,
so this template includes a GitHub Actions workflow
Expand All @@ -22,3 +23,16 @@ Contains the static files that will be copied to the build folder.

### templates
Contains the HTML templates that will be used to generate the static site from.

## Using this template
1. Click the green `Use this template` button in the top right and `Create a new repository`
2. Choose a descriptive repository name, like "My-Cool-Website" or something, and optionally fill in the description
3. Click the green `Create repository` button in the bottom right
4. Once it's done, go to the `Settings` tab on the top
5. Go to the `Pages` section in the side bar on the left
6. In the **Build and deployment** section, click the `Source` dropdown, and choose `GitHub Actions`
7. Now go to the `Actions` tab on the top, and then go to the `Build` section in the side bar on the left
8. Click the `Run workflow` dropdown on the right, verify that it says "branch: main", and then click the green `Run workflow` button
9. After a few seconds, a new entry called "Build" should show up. Click that
10. After another few seconds, the yellow circle should become a green checkmark
11. The link to your website should show up now!

0 comments on commit afbf400

Please sign in to comment.