Skip to content

Commit 7667108

Browse files
X-starRelightX-starRelight
committed
Update Docs
1 parent 94efbcb commit 7667108

4 files changed

Lines changed: 656 additions & 36 deletions

File tree

‎.vitepress/config.mts‎

Lines changed: 52 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,8 @@ export default defineConfig({
8484
{ text: 'VPM', link: '/vpm/' },
8585
{ text: 'VPM (中文)', link: '/vpm/zh_CN/' },
8686
{ text: 'VPM (En)', link: '/vpm/en/' },
87+
{ text: '鸣谢', link: '/zh_CN/acknowledgements' },
88+
{ text: 'Acknowledgements', link: '/en/acknowledgements' },
8789
],
8890

8991
sidebar: {
@@ -142,42 +144,56 @@ export default defineConfig({
142144
},
143145
],
144146

145-
'/zh_CN/': [
146-
{
147-
text: 'Vix 语言文档',
148-
collapsed: true,
149-
items: [
150-
{ text: '什么是 Vix 语言', link: '/zh_CN/what-is-vix' },
151-
{ text: '快速入门', link: '/zh_CN/getting-started' },
152-
{ text: '语法参考', link: '/zh_CN/syntax' },
153-
{ text: '类型系统', link: '/zh_CN/types' },
154-
{ text: '函数', link: '/zh_CN/functions' },
155-
{ text: '控制流', link: '/zh_CN/control-flow' },
156-
{ text: '结构体', link: '/zh_CN/structs' },
157-
{ text: '指针', link: '/zh_CN/pointers' },
158-
{ text: '模块系统', link: '/zh_CN/modules' },
159-
{ text: '标准库', link: '/zh_CN/stdlib' },
160-
]
161-
},
162-
],
163-
'/en/': [
164-
{
165-
text: 'Vix Language Documentation',
166-
collapsed: true,
167-
items: [
168-
{ text: 'Overview', link: '/en/what-is-vix' },
169-
{ text: 'Getting Started', link: '/en/getting-started' },
170-
{ text: 'Syntax Reference', link: '/en/syntax' },
171-
{ text: 'Type System', link: '/en/types' },
172-
{ text: 'Functions', link: '/en/functions' },
173-
{ text: 'Control Flow', link: '/en/control-flow' },
174-
{ text: 'Structs', link: '/en/structs' },
175-
{ text: 'Pointers', link: '/en/pointers' },
176-
{ text: 'Modules', link: '/en/modules' },
177-
{ text: 'Standard Library', link: '/en/stdlib' },
178-
]
179-
},
180-
],
147+
'/zh_CN/': [
148+
{
149+
text: 'Vix 语言文档',
150+
collapsed: true,
151+
items: [
152+
{ text: '什么是 Vix 语言', link: '/zh_CN/what-is-vix' },
153+
{ text: '快速入门', link: '/zh_CN/getting-started' },
154+
{ text: '语法参考', link: '/zh_CN/syntax' },
155+
{ text: '类型系统', link: '/zh_CN/types' },
156+
{ text: '函数', link: '/zh_CN/functions' },
157+
{ text: '控制流', link: '/zh_CN/control-flow' },
158+
{ text: '结构体', link: '/zh_CN/structs' },
159+
{ text: '指针', link: '/zh_CN/pointers' },
160+
{ text: '模块系统', link: '/zh_CN/modules' },
161+
{ text: '标准库', link: '/zh_CN/stdlib' },
162+
]
163+
},
164+
{
165+
text: '其他',
166+
collapsed: false,
167+
items: [
168+
{ text: '鸣谢', link: '/zh_CN/acknowledgements' },
169+
]
170+
},
171+
],
172+
'/en/': [
173+
{
174+
text: 'Vix Language Documentation',
175+
collapsed: true,
176+
items: [
177+
{ text: 'Overview', link: '/en/what-is-vix' },
178+
{ text: 'Getting Started', link: '/en/getting-started' },
179+
{ text: 'Syntax Reference', link: '/en/syntax' },
180+
{ text: 'Type System', link: '/en/types' },
181+
{ text: 'Functions', link: '/en/functions' },
182+
{ text: 'Control Flow', link: '/en/control-flow' },
183+
{ text: 'Structs', link: '/en/structs' },
184+
{ text: 'Pointers', link: '/en/pointers' },
185+
{ text: 'Modules', link: '/en/modules' },
186+
{ text: 'Standard Library', link: '/en/stdlib' },
187+
]
188+
},
189+
{
190+
text: 'Others',
191+
collapsed: false,
192+
items: [
193+
{ text: 'Acknowledgements', link: '/en/acknowledgements' },
194+
]
195+
},
196+
],
181197
'/vpm/': [
182198
{
183199
text: 'Vix 包管理器',

‎en/acknowledgements.md‎

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
<script setup>
2+
import { VPTeamMembers } from 'vitepress/theme'
3+
4+
const members_Core = [
5+
{
6+
avatar: 'https://avatars.githubusercontent.com/u/228652034?v=4',
7+
name: 'Daweidie',
8+
title: 'Compiler core implementation, language design, documentation writing',
9+
links: [
10+
{ icon: 'github', link: 'https://github.com/Daweidie' },
11+
]
12+
},
13+
]
14+
15+
const members_Contributor = [
16+
{
17+
avatar: 'https://avatars.githubusercontent.com/u/177229499?v=4',
18+
name: 'zty1203py',
19+
title: 'EBNF writing',
20+
links: [
21+
{ icon: 'github', link: 'https://github.com/zty1203py' },
22+
]
23+
},
24+
{
25+
avatar: 'https://avatars.githubusercontent.com/u/136948328?v=4',
26+
name: 'fexcode',
27+
title: 'VPM development and writing, website setup',
28+
links: [
29+
{ icon: 'github', link: 'https://github.com/fexcode' },
30+
]
31+
},
32+
{
33+
avatar: 'https://images-sxxyrry.pages.dev/sxxyrryAvatar.png',
34+
name: 'XR/sxxyrry/みらいの落英',
35+
title: 'Documentation writing, documentation website setup',
36+
links: [
37+
{ icon: 'github', link: 'https://github.com/sxxyrry' },
38+
]
39+
},
40+
]
41+
</script>
42+
43+
# Acknowledgements
44+
45+
Vix 0.1.0 is the result of the collective efforts of many people. We would like to express our sincere gratitude to everyone who has helped the project.
46+
47+
## Project Team
48+
49+
### Core Development
50+
51+
<VPTeamMembers size="small" :members="members_Core" />
52+
53+
### Contributors
54+
55+
<VPTeamMembers size="small" :members="members_Contributor" />
56+
57+
## Community Contributors
58+
59+
Thanks to the following developers for their contributions:
60+
61+
- Thanks to all developers who submitted Issues and Pull Requests
62+
- Thanks to users who provided valuable suggestions and feedback
63+
- Thanks to contributors who helped improve the documentation
64+
65+
## Core Dependencies
66+
67+
Vix development relies on the following excellent open source projects:
68+
69+
### Compiler Backend
70+
71+
- **[LLVM](https://llvm.org/)** - Compiler backend
72+
- Provides powerful optimization capabilities and multi-architecture support
73+
- License: Apache 2.0
74+
75+
### Standard Library
76+
77+
- **[libc](https://en.wikipedia.org/wiki/C_standard_library)** - C Standard Library
78+
- Provides C language runtime support
79+
- Vix compiler (vixc) relies on libc for low-level operations
80+
81+
### Build Tools
82+
83+
- **[Make](https://www.gnu.org/software/make/)** - Build tool
84+
- Manages vixc compilation process through Makefile
85+
- License: GPL v3
86+
87+
- **[CMake](https://cmake.org/)** - Cross-platform build system
88+
- Provides cross-platform build configuration
89+
- Used for vixc project building and dependency management
90+
- License: BSD 3-Clause
91+
92+
### Documentation Tools
93+
94+
- **[VitePress](https://vitepress.dev/)** - Documentation framework
95+
- Provides clean and efficient static site generation
96+
- License: MIT
97+
98+
- **[Vue.js](https://vuejs.org/)** - UI framework
99+
- Provides modern frontend interaction experience
100+
- License: MIT
101+
102+
- **[Vite](https://vitejs.dev/)** - Build tool
103+
- Provides extremely fast development experience
104+
- License: MIT
105+
106+
- **[Shiki](https://shiki.style/)** - Code highlighting
107+
- Provides beautiful code syntax highlighting
108+
- License: MIT
109+
110+
- **[TypeScript](https://www.typescriptlang.org/)** - Type system
111+
- Provides powerful type support
112+
- License: Apache 2.0
113+
114+
## Special Thanks
115+
116+
- Thanks to all users and developers who use Vix, your feedback and suggestions are the driving force for our continuous improvement
117+
- Thanks to the open source community for providing valuable resources and support
118+
- Thanks to the LLVM community for providing excellent compiler infrastructure
119+
- Thanks to all individuals and organizations who have contributed to the Vix project
120+
121+
## Resource Support
122+
123+
- **[GitHub](https://github.com/)** - Code hosting and collaboration platform
124+
- **[VitePress](https://vitepress.dev/)** - Documentation site building tool
125+
126+
---
127+
128+
## How to Contribute
129+
130+
If you'd like to contribute to Vix, we welcome the following forms of help:
131+
132+
- **Code Contribution**: Submit Pull Requests to fix bugs or add new features
133+
- **Documentation Improvement**: Improve documentation, correct errors, or translate documentation
134+
- **Issue Reporting**: Submit Issues to report bugs or suggest features
135+
- **Testing**: Test Vix functionality on different platforms and scenarios
136+
- **Promotion**: Introduce and recommend Vix to others
137+
138+
[View GitHub Repository](https://github.com/vixlang) | [Submit Issue](https://github.com/vixlang/VixDocs/issues) | [Create Pull Request](https://github.com/vixlang/VixDocs/pulls)
139+
140+
---
141+
142+
**Thank you again to all individuals and organizations who have contributed to the Vix project!**
143+
144+
The successful release of Vix 0.1.0 would not have been possible without the efforts and contributions of every contributor!

0 commit comments

Comments
 (0)