Skip to content

Commit

Permalink
Explain how to blog in README
Browse files Browse the repository at this point in the history
  • Loading branch information
deccer committed Oct 26, 2024
1 parent a677b7f commit 5d9e751
Showing 1 changed file with 40 additions and 5 deletions.
45 changes: 40 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,53 @@
# blog

The Graphics Programming Blog - A collection of technical articles, project posts and show cases.

## Things which work
- You can create articles and project posts

## Things which don't work yet
- Search
- Tags
- Show case is not thought through yet.

## How to get started
- Fork the repo
- Clone your fork
- Write the technical article or project post by placing the file in the right directory inside content/
- 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
- 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)
- Once installed, simply run `zola serve` and follow instructions on the screen, it will most likely point to `http://localhost:1111`
- Write the technical article or project post by placing the file in the right directory inside blog/

I think a good folder structure is the following

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

`yyyy/yyyy-MM-dd-short-description/index.md`

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

- 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

Example "front matter" (such a weird term)

```yaml
---
title: "GLSL Development Made Shrimple"
slug: glsl-development-made-shrimple
description: "Tips and tools to make GLSL development easier"
date: "2024-10-17"
authors: ["jaker"]
tags: ["glsl", "opengl", "vulkan", "beginner", "visual studio", "visual studio code", "article"]
---
```

In this case you can also see how jaker put his article into `2024/2024-10-17-glsl-development-made-shrimple/index.md`

- 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.

- Try it out locally:
You need nodejs/npm installed.

```bash
cd blog
npm i
npm run start
```

- `http://localhost:3000` should open automatically

0 comments on commit 5d9e751

Please sign in to comment.