-
-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 4958804
Showing
78 changed files
with
4,342 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# Auto detect text files and perform LF normalization | ||
* text=auto |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
{ | ||
"$schema": "https://docs.renovatebot.com/renovate-schema.json", | ||
"extends": [ | ||
"local>Innei/renovate-config" | ||
], | ||
"ignoreDeps": [ | ||
"next" // https://github.com/shuding/nextra/issues/1785 | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
name: Build CI | ||
|
||
on: | ||
pull_request: | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
|
||
- name: Setup Bun | ||
uses: oven-sh/setup-bun@v1 | ||
with: | ||
bun-version: latest | ||
|
||
- name: Build project | ||
run: | | ||
bun install | ||
bun run build |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
name: Deploy | ||
|
||
on: | ||
push: | ||
branches: [main] | ||
workflow_dispatch: | ||
|
||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
|
||
strategy: | ||
matrix: | ||
node-version: [20.x] | ||
|
||
steps: | ||
- uses: actions/checkout@v3 | ||
- name: Use Node.js ${{ matrix.node-version }} | ||
uses: actions/setup-node@v3 | ||
with: | ||
node-version: ${{ matrix.node-version }} | ||
- name: Setup Bun | ||
uses: oven-sh/setup-bun@v1 | ||
with: | ||
bun-version: latest | ||
|
||
- name: Build project | ||
run: | | ||
bun install | ||
bun run build | ||
- name: Add CNAME | ||
run: | | ||
echo "mx-space.js.org" > out/CNAME | ||
- name: Deploy | ||
uses: peaceiris/actions-gh-pages@v3 | ||
with: | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
publish_dir: out | ||
env: | ||
CI: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# deps | ||
/node_modules | ||
|
||
# generated content | ||
.contentlayer | ||
.content-collections | ||
.source | ||
|
||
# test & build | ||
/coverage | ||
/.next/ | ||
/out/ | ||
/build | ||
*.tsbuildinfo | ||
|
||
# misc | ||
.DS_Store | ||
*.pem | ||
/.pnp | ||
.pnp.js | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
|
||
# others | ||
.env*.local | ||
.vercel | ||
next-env.d.ts |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# Mix Space Documentation v3 | ||
|
||
## Contributing 贡献 | ||
|
||
这个站点使用的是 [Pumadocs](https://fumadocs.vercel.app) 程序。站点内容使用 MDX 编写,文档文件在 `/content/docs` 文件夹中。如果只有一些简单的修改,你可以直接在 GitHub 网页端进行修改并新建一个 Pull Request. | ||
|
||
在本地开发中,[bun](https://bun.sh/) 被选用为项目的包管理器,你需要使用 bun 安装依赖: | ||
|
||
```bash | ||
bun i | ||
bun run dev | ||
bun run build | ||
``` | ||
|
||
## Working on the content 修改文字 | ||
|
||
- 关于支持的 MDX 扩展和在 MDX 内部使用 React 语法的能力,请参阅 Pumadocs 文档 | ||
- 有关编写和维护文档内容的规则和建议,请参阅编写指南。 | ||
|
||
## Guide 编写指南 | ||
|
||
<u>**新增一个章节**</u>: | ||
|
||
1. 克隆此项目 | ||
2. 在 `content/docs` 文件夹中,新增一个文件夹,请语义化命名,假设为 `test` | ||
3. 编写内容,具体可以借鉴其他文档文件夹,请务必设置了父文件夹的 `meta.json` 文件,具体请参考 Pumadocs 文档 | ||
4. 创建 Pull Request. 其余审核的事情只需要交给我们来做就好了 | ||
|
||
**<u>编写内容的时候需要注意的事情</u>**: | ||
|
||
1. 中文与英文之间请保留一个空格,如`测试 test 测试` | ||
|
||
## Author | ||
|
||
Docs © Mix Space Team, Released under MIT. Created on Nov 2, 2024 |
Large diffs are not rendered by default.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
import type { ReactNode } from 'react'; | ||
import { HomeLayout } from 'fumadocs-ui/layouts/home'; | ||
import { baseOptions } from '@/app/layout.config'; | ||
|
||
export default function Layout({ | ||
children, | ||
}: { | ||
children: ReactNode; | ||
}): React.ReactElement { | ||
return ( | ||
<HomeLayout {...baseOptions}> | ||
{children} | ||
<Footer /> | ||
</HomeLayout> | ||
); | ||
} | ||
|
||
|
||
|
||
function Footer(): React.ReactElement { | ||
return ( | ||
<footer className="mt-auto border-t bg-fd-card py-12 text-fd-secondary-foreground"> | ||
<div className="container flex flex-col gap-4 sm:flex-row sm:items-end sm:justify-between"> | ||
<div> | ||
<p className="mb-1 text-sm font-semibold">Mix Space </p> | ||
<p className="text-xs"> | ||
Built with ❤️ by {2021}-{new Date().getFullYear()} by{' '} | ||
<a | ||
href="https://github.com/mx-space" | ||
rel="noreferrer noopener" | ||
target="_blank" | ||
className="font-medium" | ||
> | ||
Mix Space Team | ||
</a> | ||
</p> | ||
<p className="text-xs"> | ||
This project is licensed under AGPLv3 with additional terms, and this documentation is licensed under CC BY 4.0. | ||
</p> | ||
</div> | ||
</div> | ||
</footer> | ||
); | ||
} |
Oops, something went wrong.