Skip to content

Commit 120eb3c

Browse files
committed
Setup docs site
1 parent 2f4e08c commit 120eb3c

21 files changed

+8321
-0
lines changed

β€Ž.github/FUNDING.yamlβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: [Folyd]
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: Deploy AIScript docs site to Pages
2+
3+
on:
4+
push:
5+
branches: [main]
6+
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
concurrency:
15+
group: pages
16+
cancel-in-progress: false
17+
18+
jobs:
19+
# Build job
20+
build:
21+
runs-on: ubuntu-latest
22+
steps:
23+
- name: Checkout
24+
uses: actions/checkout@v4
25+
with:
26+
fetch-depth: 0 # Not needed if lastUpdated is not enabled
27+
- uses: pnpm/action-setup@v3 # pnpm is optional but recommended, you can also use npm / yarn
28+
with:
29+
version: 8
30+
- name: Change directory
31+
run: cd aiscript-docs
32+
- name: Setup Node
33+
uses: actions/setup-node@v4
34+
with:
35+
node-version: 20
36+
- name: Setup Pages
37+
uses: actions/configure-pages@v5
38+
- name: Install dependencies
39+
run: pnpm install
40+
- name: Build with Rspress
41+
run: |
42+
pnpm run build
43+
- name: Upload artifact
44+
uses: actions/upload-pages-artifact@v3
45+
with:
46+
path: doc_build
47+
48+
# Deployment job
49+
deploy:
50+
environment:
51+
name: github-pages
52+
url: ${{ steps.deployment.outputs.page_url }}
53+
needs: build
54+
runs-on: ubuntu-latest
55+
name: Deploy
56+
steps:
57+
- name: Deploy to GitHub Pages
58+
id: deployment
59+
uses: actions/deploy-pages@v4

β€ŽREADME.mdβ€Ž

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Rspress website
2+
3+
## Setup
4+
5+
Install the dependencies:
6+
7+
```bash
8+
npm install
9+
```
10+
11+
## Get started
12+
13+
Start the dev server:
14+
15+
```bash
16+
npm run dev
17+
```
18+
19+
Build the website for production:
20+
21+
```bash
22+
npm run build
23+
```
24+
25+
Preview the production build locally:
26+
27+
```bash
28+
npm run preview
29+
```

β€Žbiome.jsonβ€Ž

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
"$schema": "https://biomejs.dev/schemas/1.8.0/schema.json",
3+
"organizeImports": {
4+
"enabled": true
5+
},
6+
"vcs": {
7+
"enabled": true,
8+
"clientKind": "git",
9+
"useIgnoreFile": true
10+
},
11+
"formatter": {
12+
"indentStyle": "space"
13+
},
14+
"javascript": {
15+
"formatter": {
16+
"quoteStyle": "single"
17+
}
18+
},
19+
"css": {
20+
"parser": {
21+
"cssModules": true
22+
}
23+
},
24+
"linter": {
25+
"enabled": true,
26+
"rules": {
27+
"recommended": true
28+
}
29+
}
30+
}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[{"id":0,"title":"","content":"Get started","routePath":"/get-started/","lang":"","toc":[],"domain":"","frontmatter":{},"version":""},{"id":1,"title":"AIScript","content":"#","routePath":"/guide/","lang":"","toc":[],"domain":"","frontmatter":{},"version":""},{"id":3,"title":"","content":"Std library","routePath":"/std-library/","lang":"","toc":[],"domain":"","frontmatter":{},"version":""}]

β€Ždocs/_meta.jsonβ€Ž

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
[
2+
{
3+
"text": "Guide",
4+
"link": "/guide/",
5+
"activeMatch": "/guide/"
6+
},
7+
{
8+
"text": "Get Started",
9+
"link": "/get-started/",
10+
"activeMatch": "/get-started/"
11+
},
12+
{
13+
"text": "Std library",
14+
"link": "/std-library/",
15+
"activeMatch": "/std-library/"
16+
}
17+
]

β€Ždocs/get-started/index.mdβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Get started

β€Ždocs/guide/_meta.jsonβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
["index"]

β€Ždocs/guide/index.mdβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# AIScript

β€Ždocs/index.mdβ€Ž

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
pageType: home
3+
4+
hero:
5+
name: AIScript
6+
text: The next generation language for human and AI.
7+
# tagline: This is the tagline
8+
actions:
9+
- theme: brand
10+
text: Quick Start
11+
link: /guide/
12+
- theme: alt
13+
text: GitHub
14+
link: https://github.com/aiscriptdev/aiscript
15+
image:
16+
src: /tuocan.png
17+
alt: Logo
18+
features:
19+
- title: Blazing fast build speed
20+
details: The core compilation module is based on the Rust front-end toolchain, providing a more ultimate development experience.
21+
icon: πŸƒπŸ»β€β™€οΈ
22+
- title: Support for MDX content writing
23+
details: MDX is a powerful way to write content, allowing you to use React components in Markdown.
24+
icon: πŸ“¦
25+
- title: Built-in full-text search
26+
details: Automatically generates a full-text search index for you during construction, providing out-of-the-box full-text search capabilities.
27+
icon: 🎨
28+
- title: Simpler I18n solution
29+
details: With the built-in I18n solution, you can easily provide multi-language support for documents or components.
30+
icon: 🌍
31+
- title: Static site generation
32+
details: In production, it automatically builds into static HTML files, which can be easily deployed anywhere.
33+
icon: 🌈
34+
- title: Providing multiple custom capabilities
35+
details: Through its extension mechanism, you can easily extend theme UI and build process.
36+
icon: πŸ”₯
37+
---

0 commit comments

Comments
Β (0)