-
Notifications
You must be signed in to change notification settings - Fork 104
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
10 changed files
with
122 additions
and
259 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
name: Publish Github Pages | ||
on: | ||
push: | ||
branches: [main] | ||
|
||
jobs: | ||
# Build job | ||
build: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
|
||
- name: Setup Zig | ||
uses: mlugg/setup-zig@v1 | ||
with: | ||
version: 0.13.0 | ||
|
||
- name: Build | ||
run: zig build | ||
|
||
- name: Upload Artifact | ||
uses: actions/upload-pages-artifact | ||
id: deployment | ||
with: | ||
path: zig-out/www | ||
|
||
|
||
# Deploy job | ||
deploy: | ||
# Add a dependency to the build job | ||
needs: build | ||
|
||
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment | ||
permissions: | ||
pages: write # to deploy to Pages | ||
id-token: write # to verify the deployment originates from an appropriate source | ||
|
||
# Deploy to the github-pages environment | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
|
||
# Specify runner + deployment step | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v4 # or specific "vX.X.X" version tag for this action |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,3 @@ | ||
# Zig Embedded Group - Website and Articles | ||
|
||
This project both contains the contents and the generation of the ZEG website. | ||
|
||
## Folder Structure | ||
|
||
``` | ||
. | ||
├── build.zig | ||
├── deps Contains submodule dependencies | ||
│ └── … | ||
├── LICENCE | ||
├── README.md | ||
├── render Not included in the repo, will contain the rendered website | ||
│ └── … | ||
├── src Source of the website generator and other tools | ||
│ └── main.zig | ||
└── website Contains the raw input data for the website | ||
├── articles Contains all articles in the format `YYYY-MM-dd - ${TITLE}.md` | ||
│ └── … | ||
├── img Contains the images used on the website. | ||
│ └── … | ||
├── index.md Index page of the website | ||
└── tutorials Contains the raw tutorial files | ||
└── … | ||
``` | ||
|
||
## Markdown | ||
|
||
The website uses basic markdown that allows GFM style tables and also supports *some* placeholders: | ||
|
||
- `<!-- TOC -->` will insert a table of contents if alone in a single line. The ToC will be rendered in the same depth as the next heading, so everything higher in the hierarchy will be ignored. | ||
- `<!-- ARTICLES -->` renders a list of all available articles | ||
- `<!-- ARTICLES10 -->` renders a list of the 10 latest articles |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
File renamed without changes.
File renamed without changes.
Oops, something went wrong.