Skip to content

Commit def7097

Browse files
authored
Merge pull request #104 from gosuda/feature/readme-quickstart
README: add quickstart
2 parents 3c9500a + 1ac454e commit def7097

1 file changed

Lines changed: 28 additions & 2 deletions

File tree

README.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,29 @@
1-
# Website
1+
# Gosuda Website
22

3-
Home of the gosuda.org [go-import, blog]
3+
[![Website](https://img.shields.io/badge/visit-gosuda.org-blue?style=flat-square)](https://gosuda.org)
4+
5+
This repository contains the source code for the Gosuda static website and blog. All content is written in Markdown and automatically processed through CI/CD for **translation and deployment**.
6+
7+
## ✍️ Writing a new post
8+
9+
### 1. **Create a Markdown file in `/root/blog/`**
10+
```bash
11+
blog/my-new-post.md
12+
```
13+
14+
### 2. **Add frontmatter metadata (at the top of the file)**
15+
```yaml
16+
---
17+
author: <Your Name>
18+
title: <Post Title>
19+
---
20+
```
21+
22+
### 3. **Write your content in Markdown**
23+
24+
### 4. **Commit, Push, and Open a Pull Request**
25+
```bash
26+
git add blog/my-new-post.md
27+
git commit -m "Add new blog post: my-new-post"
28+
git push origin my-branch
29+
```

0 commit comments

Comments
 (0)