Skip to content

Commit 517b330

Browse files
committed
Replace Zola with Docusaurus static site generator
1 parent c21e313 commit 517b330

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+16556
-739
lines changed

.github/workflows/deploy.yml

Lines changed: 32 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,51 @@
1-
name: Deploy to Pages
1+
name: Deploy to GitHub Pages
22

33
on:
4-
# Runs on pushes targeting the default branch
54
push:
6-
branches: ["main"]
7-
8-
# Allows you to run this workflow manually from the Actions tab
9-
workflow_dispatch:
10-
11-
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
12-
permissions:
13-
contents: read
14-
pages: write
15-
id-token: write
16-
17-
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
18-
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
19-
concurrency:
20-
group: "pages"
21-
cancel-in-progress: false
22-
23-
# Default to bash
24-
defaults:
25-
run:
26-
shell: bash
5+
branches:
6+
- main
7+
# Review gh actions docs if you want to further define triggers, paths, etc
8+
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
279

2810
jobs:
29-
# Build job
3011
build:
12+
name: Build Docusaurus
3113
runs-on: ubuntu-latest
32-
env:
33-
ZOLA_VERSION: "0.19.1"
3414
steps:
35-
- name: Install Zola
36-
run: |
37-
set -x
38-
wget -O - \
39-
"https://github.com/getzola/zola/releases/download/v${ZOLA_VERSION}/zola-v${ZOLA_VERSION}-x86_64-unknown-linux-gnu.tar.gz" \
40-
| sudo tar xzf - -C /usr/local/bin
41-
- name: Checkout
42-
uses: actions/checkout@v3
15+
- uses: actions/checkout@v4
16+
with:
17+
fetch-depth: 0
18+
- uses: actions/setup-node@v4
4319
with:
44-
submodules: recursive
45-
- name: Setup Pages
46-
id: pages
47-
uses: actions/configure-pages@v3
48-
- name: Build with Zola
49-
run: |
50-
zola build
51-
- name: Upload artifact
52-
uses: actions/upload-pages-artifact@v1
20+
node-version: 18
21+
cache: yarn
22+
23+
- name: Install dependencies
24+
run: yarn install --frozen-lockfile
25+
- name: Build website
26+
run: yarn build
27+
28+
- name: Upload Build Artifact
29+
uses: actions/upload-pages-artifact@v3
5330
with:
54-
path: ./public
31+
path: build
5532

56-
# Deployment job
5733
deploy:
34+
name: Deploy to GitHub Pages
35+
needs: build
36+
37+
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
38+
permissions:
39+
pages: write # to deploy to Pages
40+
id-token: write # to verify the deployment originates from an appropriate source
41+
42+
# Deploy to the github-pages environment
5843
environment:
5944
name: github-pages
6045
url: ${{ steps.deployment.outputs.page_url }}
46+
6147
runs-on: ubuntu-latest
62-
needs: build
6348
steps:
6449
- name: Deploy to GitHub Pages
6550
id: deployment
66-
uses: actions/deploy-pages@v2
51+
uses: actions/deploy-pages@v4

babel.config.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
3+
};
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
slug: first-blog-post
3+
title: First Blog Post
4+
authors: [jaker]
5+
tags: [hola, docusaurus]
6+
---
7+
8+
Lorem ipsum dolor sit amet...
9+
10+
<!-- truncate -->
11+
12+
...consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
slug: long-blog-post
3+
title: Long Blog Post
4+
authors: deccer
5+
tags: [hello, docusaurus]
6+
---
7+
8+
This is the summary of a very long blog post,
9+
10+
Use a `<!--` `truncate` `-->` comment to limit blog post size in the list view.
11+
12+
<!-- truncate -->
13+
14+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
15+
16+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
17+
18+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
19+
20+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
21+
22+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
23+
24+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
25+
26+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
27+
28+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
29+
30+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
31+
32+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
33+
34+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
35+
36+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
37+
38+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
39+
40+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
41+
42+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
43+
44+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

content/articles/2024-10-17-glsl-development-made-shrimple.md renamed to blog/2024/2024-10-17-glsl-development-made-shrimple.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
1-
+++
2-
title = "GLSL Development Made Shrimple"
3-
description = "Tips and tools to make GLSL development easier"
4-
date = "2024-10-17"
5-
6-
#[taxonomies]
7-
author = ["Jaker"]
8-
tags = ["glsl", "opengl", "vulkan", "beginner", "visual studio", "visual studio code"]
9-
categories = ["article"]
10-
+++
1+
---
2+
title: "GLSL Development Made Shrimple"
3+
slug: glsl-development-made-shrimple
4+
description: "Tips and tools to make GLSL development easier"
5+
date: "2024-10-17"
6+
authors: ["jaker"]
7+
tags: ["glsl", "opengl", "vulkan", "beginner", "visual studio", "visual studio code", "article"]
8+
---
9+
1110
# GLSL Linters
11+
1212
Life is so much better when you get instant feedback on the errors you make.
13+
1314
## Visual Studio Code
1415
- [GLSL Lint](https://marketplace.visualstudio.com/items?itemName=dtoplak.vscode-glsllint): provides syntax highlighting and error detection.
1516
- Requires glslangValidator from [the Vulkan SDK](https://www.lunarg.com/vulkan-sdk/) or compiled yourself. The path to the executable must be supplied in the extension settings.
@@ -19,6 +20,7 @@ Life is so much better when you get instant feedback on the errors you make.
1920
- File extensions can be associated with specific shader stages in the extension settings. By default, it will detect common file extensions like .vert, .frag, and .comp. It also understands .frag.glsl, etc. automatically.
2021
- Supports my convoluted `#include` hierarchies.
2122
- [Error Lens](https://marketplace.visualstudio.com/items?itemName=usernamehw.errorlens): makes errors easier to read. Not specifically related to GLSL, but still useful to have.
23+
2224
## Visual Studio
2325
- [GLSL language integration (for VS 2022)](https://marketplace.visualstudio.com/items?itemName=DanielScherzer.GLSL2022): provides syntax highlighting and error detection.
2426
- Similar to GLSL Lint for Visual Studio Code in terms of features.
@@ -32,7 +34,9 @@ Life is so much better when you get instant feedback on the errors you make.
3234
- Has no extension settings.
3335
- Only supports OpenGL GLSL.
3436
- Does not use an external GLSL compiler.
37+
3538
# Code Reuse
39+
3640
## `#include` support
3741
OpenGL GLSL doesn't support `#include` (GL_ARB_shading_language_include barely counts), so we must find an external way to support it. There are a few viable ways to gain support for `#include` in your shaders if you're using OpenGL, in increasing effort:
3842

@@ -47,6 +51,7 @@ OpenGL GLSL doesn't support `#include` (GL_ARB_shading_language_include barely c
4751
- Both glslang and shaderc require writing an include handler to tell the compiler where to find included files. This gets a bit hairy with nested includes. I'm surprised there isn't a default implementation, so [here's a link to my hacky one](https://github.com/JuanDiegoMontoya/Frogfood/blob/main/src/Fvog/Shader2.cpp#L70-L116).
4852

4953
### Vulkan
54+
5055
Since Vulkan GLSL users are likely to be already using glslang in some fashion (be it the CLI or API), adding support for `#include` is straightforward. CLI users don't have to do anything. API users must write an include handler as outlined above. In either case, I suggest adding `#extension GL_GOOGLE_include_directive : enable` to the preamble to preserve your fingers (`--P` in the CLI, `TShader::setPreamble` in the API).
5156
## Sharing Code Between the Device and Host
5257
Writing the same structure definitions for buffers in both C or C++ and GLSL is annoying and prone to error.

blog/authors.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
jaker:
2+
name: Jaker
3+
title: Senior Frog @ GP
4+
url: https://github.com/JuanDiegoMontoya
5+
image_url: https://avatars.githubusercontent.com/u/38368197?v=4
6+
page: true
7+
socials:
8+
github: JuanDiegoMontoya
9+
10+
deccer:
11+
name: deccer
12+
title: Frog
13+
url: https://github.com/deccer
14+
image_url: https://avatars.githubusercontent.com/u/15695435?v=4
15+
page:
16+
# customize the url of the author page at /blog/authors/<permalink>
17+
permalink: '/all-sebastien-lorber-articles'
18+
socials:
19+
github: deccer

blog/tags.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
opengl:
2+
label: opengl
3+
permalink: /opengl
4+
description: Open Graphics Library
5+
6+
glsl:
7+
label: Hello
8+
permalink: /glsl
9+
description: OpenGL Shading Language
10+

config.toml

Lines changed: 0 additions & 24 deletions
This file was deleted.

content/articles/2024-10-01-first-article.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

content/articles/2024-10-02-second-article.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

content/articles/_index.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

content/authors/_index.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

content/authors/jaker.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

content/projects/2024-10-07-enginekit.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

content/projects/_index.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

content/showcase/_index.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

content/tags/_index.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

0 commit comments

Comments
 (0)