|
1 | 1 | # blog
|
| 2 | + |
2 | 3 | The Graphics Programming Blog - A collection of technical articles, project posts and show cases.
|
3 | 4 |
|
4 | 5 | ## Things which work
|
5 | 6 | - You can create articles and project posts
|
6 | 7 |
|
7 | 8 | ## Things which don't work yet
|
8 | 9 | - Search
|
9 |
| -- Tags |
10 | 10 | - Show case is not thought through yet.
|
11 | 11 |
|
12 | 12 | ## How to get started
|
13 | 13 | - Fork the repo
|
14 | 14 | - Clone your fork
|
15 |
| -- Write the technical article or project post by placing the file in the right directory inside content/ |
16 |
| -- Make sure you hookup the right "front matter", thats the first few lines each markdown file needs to have, containing meta data about your post |
17 |
| -- Try it out locally by installing zola, you can get it [there](https://www.getzola.org/documentation/getting-started/installation/) (it comes with instructions for all OSes) |
18 |
| -- Once installed, simply run `zola serve` and follow instructions on the screen, it will most likely point to `http://localhost:1111` |
| 15 | +- Write the technical article or project post by placing the file in the right directory inside blog/ |
| 16 | + |
| 17 | + I think a good folder structure is the following |
| 18 | + |
| 19 | + a folder per year and inside a folder with a timestamp in form of yyyy-MM-dd and a short description of your blog entry, perhaps the slug of your post |
| 20 | + |
| 21 | + `yyyy/yyyy-MM-dd-short-description/index.md` |
| 22 | + |
| 23 | + index.md will be your main entry point and you can put whatever accompanying stuff like images in the same folder and refer to it relative to your article as usual |
| 24 | + |
| 25 | +- The second important bit here is the so called 'front matter' of the post, that one defines things like article date, authors, and tags, here is also where you define a slug |
| 26 | + |
| 27 | + Example "front matter" (such a weird term) |
| 28 | + |
| 29 | + ```yaml |
| 30 | + --- |
| 31 | + title: "GLSL Development Made Shrimple" |
| 32 | + slug: glsl-development-made-shrimple |
| 33 | + description: "Tips and tools to make GLSL development easier" |
| 34 | + date: "2024-10-17" |
| 35 | + authors: ["jaker"] |
| 36 | + tags: ["glsl", "opengl", "vulkan", "beginner", "visual studio", "visual studio code", "article"] |
| 37 | + --- |
| 38 | + ``` |
| 39 | + |
| 40 | + In this case you can also see how jaker put his article into `2024/2024-10-17-glsl-development-made-shrimple/index.md` |
| 41 | + |
| 42 | +- Consider adding your author tag to blog/authors.yml. Simply check how jaker/deccer were added and massage yours accordingly. The key of each entry is also the value which goes into the `authors: ["author_here", "coauthor"]` thing. |
| 43 | + |
| 44 | +- Try it out locally: |
| 45 | + You need nodejs/npm installed. |
| 46 | + |
| 47 | + ```bash |
| 48 | + cd blog |
| 49 | + npm i |
| 50 | + npm run start |
| 51 | + ``` |
| 52 | + |
| 53 | +- `http://localhost:3000` should open automatically |
0 commit comments