Skip to content

Commit 74d37ff

Browse files
timerringtimerring
committed
docs: pre release
1 parent b4aba11 commit 74d37ff

File tree

480 files changed

+44332
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

480 files changed

+44332
-0
lines changed

‎.devcontainer/devcontainer.json

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
2+
// README at: https://github.com/devcontainers/templates/tree/main/src/typescript-node
3+
{
4+
"name": "nolebase-integrations",
5+
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
6+
"image": "mcr.microsoft.com/devcontainers/typescript-node:1-22-bookworm",
7+
8+
// Features to add to the dev container. More info: https://containers.dev/features.
9+
"features": {
10+
"ghcr.io/devcontainers-contrib/features/pnpm:2": {}
11+
},
12+
13+
// Use 'forwardPorts' to make a list of ports inside the container available locally.
14+
"forwardPorts": [5173, 4173],
15+
"portsAttributes": {
16+
"5173": {
17+
"label": "dev port"
18+
},
19+
"4173": {
20+
"label": "build port"
21+
}
22+
},
23+
24+
// Use 'postCreateCommand' to run commands after the container is created.
25+
"postCreateCommand": "pnpm i",
26+
// "postStartCommand": "pnpm docs:dev",
27+
28+
// Configure tool-specific properties.
29+
"customizations": {
30+
"vscode": {
31+
// Set *default* container specific settings.json values on container create.
32+
"extensions": [
33+
"streetsidesoftware.code-spell-checker",
34+
"mikestead.dotenv",
35+
"EditorConfig.EditorConfig",
36+
"usernamehw.errorlens",
37+
"dbaeumer.vscode-eslint",
38+
"antfu.goto-alias",
39+
"lokalise.i18n-ally",
40+
"antfu.iconify",
41+
"yzhang.markdown-all-in-one",
42+
"antfu.unocss",
43+
"Vue.volar",
44+
"vitest.explorer",
45+
"redhat.vscode-yaml"
46+
]
47+
},
48+
"codespaces": {
49+
"openFiles": [
50+
"./README.md"
51+
]
52+
}
53+
}
54+
55+
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
56+
// "remoteUser": "root"
57+
}

‎.editorconfig

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
indent_style = space
6+
indent_size = 2
7+
end_of_line = lf
8+
insert_final_newline = true
9+
trim_trailing_whitespace = true

‎.github/renovate.json

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
3+
"extends": ["local>nolebase/renovate-config", "schedule:weekly"]
4+
}

‎.github/workflows/deploy.yml

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# 构建 VitePress 站点并将其部署到 GitHub Pages 的示例工作流程
2+
#
3+
name: Deploy VitePress site to Pages
4+
5+
on:
6+
# 在针对 `main` 分支的推送上运行。如果你
7+
# 使用 `master` 分支作为默认分支，请将其更改为 `master`
8+
push:
9+
branches: [main]
10+
11+
# 允许你从 Actions 选项卡手动运行此工作流程
12+
workflow_dispatch:
13+
14+
# 设置 GITHUB_TOKEN 的权限，以允许部署到 GitHub Pages
15+
permissions:
16+
contents: read
17+
pages: write
18+
id-token: write
19+
20+
# 只允许同时进行一次部署，跳过正在运行和最新队列之间的运行队列
21+
# 但是，不要取消正在进行的运行，因为我们希望允许这些生产部署完成
22+
concurrency:
23+
group: pages
24+
cancel-in-progress: false
25+
26+
jobs:
27+
# 构建工作
28+
build:
29+
runs-on: ubuntu-latest
30+
steps:
31+
- name: Checkout
32+
uses: actions/checkout@v4
33+
with:
34+
fetch-depth: 0 # 如果未启用 lastUpdated，则不需要
35+
- uses: pnpm/action-setup@v3 # 如果使用 pnpm，请取消此区域注释
36+
with:
37+
version: 9
38+
# - uses: oven-sh/setup-bun@v1 # 如果使用 Bun，请取消注释
39+
- name: Setup Node
40+
uses: actions/setup-node@v4
41+
with:
42+
node-version: 22
43+
cache: pnpm # 或 pnpm / yarn
44+
- name: Setup Pages
45+
uses: actions/configure-pages@v4
46+
- name: Install dependencies
47+
run: pnpm install # 或 pnpm install / yarn install / bun install
48+
- name: Install package
49+
run: pnpm run packages:stub # 或 pnpm install / yarn install / bun install
50+
- name: Build with VitePress
51+
run: pnpm run docs:build # 或 pnpm docs:build / yarn docs:build / bun run docs:build
52+
- name: Upload artifact
53+
uses: actions/upload-pages-artifact@v3
54+
with:
55+
path: docs/.vitepress/dist
56+
57+
# 部署工作
58+
deploy:
59+
environment:
60+
name: github-pages
61+
url: ${{ steps.deployment.outputs.page_url }}
62+
needs: build
63+
runs-on: ubuntu-latest
64+
name: Deploy
65+
steps:
66+
- name: Deploy to GitHub Pages
67+
id: deployment
68+
uses: actions/deploy-pages@v4

‎.gitignore

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
.Trash/
2+
.trash/
3+
.DS_Store
4+
**/.obsidian/
5+
6+
.idea
7+
.nuxt
8+
.temp
9+
.vite-inspect
10+
*.local
11+
*.log
12+
components.d.ts
13+
dist
14+
node_modules
15+
.eslintcache
16+
**/.vitepress/docsMetadata.json
17+
**/.vitepress/cache/
18+
19+
**/.netlify/*
20+
**/.netlify/functions-serve/*
21+
22+
coverage/

‎.npmrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
link-workspace-packages=true

‎.vscode/extensions.json

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"recommendations": [
3+
"streetsidesoftware.code-spell-checker",
4+
"mikestead.dotenv",
5+
"EditorConfig.EditorConfig",
6+
"usernamehw.errorlens",
7+
"dbaeumer.vscode-eslint",
8+
"antfu.goto-alias",
9+
"lokalise.i18n-ally",
10+
"antfu.iconify",
11+
"yzhang.markdown-all-in-one",
12+
"antfu.unocss",
13+
"Vue.volar",
14+
"vitest.explorer",
15+
"redhat.vscode-yaml"
16+
]
17+
}

‎.vscode/settings.json

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"editor.formatOnSave": false,
3+
"editor.codeActionsOnSave": {
4+
"source.fixAll.eslint": "explicit",
5+
"source.organizeImports": "never"
6+
},
7+
// The following is optional.
8+
// It's better to put under project setting `.vscode/settings.json`
9+
// to avoid conflicts with working with different eslint configs
10+
// that does not support all formats.
11+
"eslint.validate": [
12+
"javascript",
13+
"javascriptreact",
14+
"typescript",
15+
"typescriptreact",
16+
"vue",
17+
"html",
18+
"markdown",
19+
"json",
20+
"jsonc",
21+
"yaml"
22+
],
23+
"typescript.tsdk": "node_modules/typescript/lib",
24+
"i18n-ally.localesPaths": [
25+
"packages/**/src/locales"
26+
],
27+
"i18n-ally.keystyle": "nested"
28+
}

‎README.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# DMXAPI documentation
2+
3+
## How to develop
4+
5+
```shell
6+
# run these scripts in root folder
7+
pnpm i
8+
pnpm run packages:stub
9+
```
10+
11+
Previewing:
12+
13+
```shell
14+
pnpm run docs:dev
15+
```
16+
17+
## How to build
18+
19+
```shell
20+
pnpm run packages:build
21+
```
22+
23+
Build the documentation site:
24+
25+
```shell
26+
pnpm run docs:build
27+
```

‎bump.config.ts

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import { defineConfig } from 'bumpp'
2+
3+
export default defineConfig({
4+
recursive: true,
5+
commit: 'release: v%s',
6+
sign: true,
7+
})

‎changelogithub.config.ts

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import { defineConfig } from 'changelogithub'
2+
3+
export default defineConfig({ draft: true })

‎cspell.config.yaml

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
version: "0.2"
2+
ignorePaths: []
3+
dictionaryDefinitions: []
4+
dictionaries: []
5+
words:
6+
- antfu
7+
- apng
8+
- asciicast
9+
- asciinema
10+
- Astro
11+
- Attributify
12+
- avatar
13+
- ayaka
14+
- Baloo
15+
- baloo-2
16+
- blurhash
17+
- bumpp
18+
- canvaskit
19+
- Chakra
20+
- chakra-petch
21+
- changelogithub
22+
- cijiugechu
23+
- colorette
24+
- composables
25+
- contributor
26+
- datetime
27+
- defu
28+
- easytag
29+
- ElMassimo
30+
- emittypes
31+
- evanw
32+
- execa
33+
- frontmatter
34+
- Gitea
35+
- graymatter
36+
- iconify
37+
- jfif
38+
- Logseq
39+
- mkdist
40+
- napi
41+
- neko
42+
- Nisekoi5
43+
- nodir
44+
- Northword
45+
- Noto
46+
- octicon
47+
- Petch
48+
- pjpeg
49+
- quotepath
50+
- Rehype
51+
- resvg
52+
- retext
53+
- rizumu
54+
- Roboto
55+
- shikijs
56+
- taze
57+
- testdata
58+
- Twoslash
59+
- unconfig
60+
- uncrypto
61+
- unlazy
62+
- unocss
63+
- unplugin
64+
- Vite
65+
- vitepress
66+
- vueuse
67+
ignoreWords: []
68+
import:
69+
- "@cspell/dict-ru_ru/cspell-ext.json"
70+
- "@nolebase/cspell-dict/cspell-ext.json"

0 commit comments

Comments
 (0)