Skip to content

Commit 920cd16

Browse files
committed
init
1 parent fc47457 commit 920cd16

27 files changed

+481
-10
lines changed

docs/ecosystem/00-index.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
sidebar_position: 0
3+
---
4+
5+
# Zig 生态
6+
7+
## Awesome:
8+
9+
- https://github.com/hhstore/blog/issues/374
10+
11+
> search:
12+
13+
- https://github.com/topics/ziglang
14+
- https://github.com/topics/zig
15+
16+
> awesome:
17+
18+
- https://github.com/nrdmn/awesome-zig
19+
- https://github.com/catdevnull/awesome-zig
20+
- https://github.com/C-BJ/awesome-zig
21+
22+
> 学习教程:
23+
24+
- https://github.com/Sobeston/ziglearn
25+
- https://ziglearn.org/
26+
- https://github.com/ratfactor/ziglings
27+
28+
## Zig 工具链:
29+
30+
> zig 编辑器 theme 主体配色:
31+
32+
- https://github.com/benbusby/colorstorm
33+
34+
> zig 版本管理工具:
35+
36+
- https://github.com/marler8997/zigup
37+
38+
> zig 包管理工具:
39+
40+
- https://github.com/catdevnull/awesome-zig#package-managers
41+
- https://github.com/zigtools/zpm
42+
- https://github.com/mattnite/gyro
43+
- https://github.com/nektro/zigmod
44+
- https://aquila.red/
45+
- https://zig.pm/
46+
- https://astrolabe.pm/
47+
48+
> zig 代码分享:
49+
50+
- https://zigbin.io/
51+
52+
> lint:
53+
54+
- https://github.com/nektro/ziglint
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# zig web 客户端:
2+
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# zig web 服务端:
2+
3+
## web 框架:
4+
5+
## web 中间件:

docs/ecosystem/02-web/01-client.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# zig web 客户端:
2+

docs/ecosystem/02-web/02-server.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# zig web 服务端:
2+
3+
## web 框架:
4+
5+
## web 中间件:

docs/guide/01-intro.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Zig 教程
6+
7+
## 快速开始:
8+
9+
- https://github.com/hhstore/blog/issues/363
10+
11+
## 官网:
12+
13+
- https://ziglang.org/zh/learn/samples
14+
15+
## 搭建开发环境:

docs/tutorial-basics/_category_.json renamed to docs/guide/02-tutorial-basics/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"label": "Tutorial - Basics",
2+
"label": "基本语法",
33
"position": 2,
44
"link": {
55
"type": "generated-index",
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "参考资料",
3+
"position": 4,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "参考资料/文献."
7+
}
8+
}
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
sidebar_position: 6
3+
---
4+
5+
# Congratulations!
6+
7+
You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
8+
9+
Docusaurus has **much more to offer**!
10+
11+
Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**.
12+
13+
Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610)
14+
15+
## What's next?
16+
17+
- Read the [official documentation](https://docusaurus.io/).
18+
- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout)
19+
- Add a [search bar](https://docusaurus.io/docs/search)
20+
- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase)
21+
- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support)
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
sidebar_position: 3
3+
---
4+
5+
# Create a Blog Post
6+
7+
Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed...
8+
9+
## Create your first Post
10+
11+
Create a file at `blog/2021-02-28-greetings.md`:
12+
13+
```md title="blog/2021-02-28-greetings.md"
14+
---
15+
slug: greetings
16+
title: Greetings!
17+
authors:
18+
- name: Joel Marcey
19+
title: Co-creator of Docusaurus 1
20+
url: https://github.com/JoelMarcey
21+
image_url: https://github.com/JoelMarcey.png
22+
- name: Sébastien Lorber
23+
title: Docusaurus maintainer
24+
url: https://sebastienlorber.com
25+
image_url: https://github.com/slorber.png
26+
tags: [greetings]
27+
---
28+
29+
Congratulations, you have made your first post!
30+
31+
Feel free to play around and edit this post as much you like.
32+
```
33+
34+
A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings).
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# Create a Document
6+
7+
Documents are **groups of pages** connected through:
8+
9+
- a **sidebar**
10+
- **previous/next navigation**
11+
- **versioning**
12+
13+
## Create your first Doc
14+
15+
Create a Markdown file at `docs/hello.md`:
16+
17+
```md title="docs/hello.md"
18+
# Hello
19+
20+
This is my **first Docusaurus document**!
21+
```
22+
23+
A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello).
24+
25+
## Configure the Sidebar
26+
27+
Docusaurus automatically **creates a sidebar** from the `docs` folder.
28+
29+
Add metadata to customize the sidebar label and position:
30+
31+
```md title="docs/hello.md" {1-4}
32+
---
33+
sidebar_label: 'Hi!'
34+
sidebar_position: 3
35+
---
36+
37+
# Hello
38+
39+
This is my **first Docusaurus document**!
40+
```
41+
42+
It is also possible to create your sidebar explicitly in `sidebars.js`:
43+
44+
```js title="sidebars.js"
45+
module.exports = {
46+
tutorialSidebar: [
47+
{
48+
type: 'category',
49+
label: 'Tutorial',
50+
// highlight-next-line
51+
items: ['hello'],
52+
},
53+
],
54+
};
55+
```
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Create a Page
6+
7+
Add **Markdown or React** files to `src/pages` to create a **standalone page**:
8+
9+
- `src/pages/index.js``localhost:3000/`
10+
- `src/pages/foo.md``localhost:3000/foo`
11+
- `src/pages/foo/bar.js``localhost:3000/foo/bar`
12+
13+
## Create your first React Page
14+
15+
Create a file at `src/pages/my-react-page.js`:
16+
17+
```jsx title="src/pages/my-react-page.js"
18+
import React from 'react';
19+
import Layout from '@theme/Layout';
20+
21+
export default function MyReactPage() {
22+
return (
23+
<Layout>
24+
<h1>My React page</h1>
25+
<p>This is a React page</p>
26+
</Layout>
27+
);
28+
}
29+
```
30+
31+
A new page is now available at [http://localhost:3000/my-react-page](http://localhost:3000/my-react-page).
32+
33+
## Create your first Markdown Page
34+
35+
Create a file at `src/pages/my-markdown-page.md`:
36+
37+
```mdx title="src/pages/my-markdown-page.md"
38+
# My Markdown page
39+
40+
This is a Markdown page
41+
```
42+
43+
A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page).
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
sidebar_position: 5
3+
---
4+
5+
# Deploy your site
6+
7+
Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**).
8+
9+
It builds your site as simple **static HTML, JavaScript and CSS files**.
10+
11+
## Build your site
12+
13+
Build your site **for production**:
14+
15+
```bash
16+
npm run build
17+
```
18+
19+
The static files are generated in the `build` folder.
20+
21+
## Deploy your site
22+
23+
Test your production build locally:
24+
25+
```bash
26+
npm run serve
27+
```
28+
29+
The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/).
30+
31+
You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**).

0 commit comments

Comments
 (0)