docs.moonbitlang.com

Author: lexon-fs

.github/workflows/check.yml

@@ -6,7 +6,7 @@ on:
       - main
   pull_request:
     paths:
-      - examples
+      - legacy/examples
   schedule:
     - cron: '0 10 * * 2'
 
@@ -50,7 +50,7 @@ jobs:
         run: |
           moon update
           failed_directories=()
-          for dir in examples/*; do
+          for dir in legacy/examples/*; do
             if [ -d "$dir" ]; then
               echo "Processing $dir"
               if ! (cd "$dir" && moon install && moon check --target ${{ matrix.backend }} && moon test --target ${{ matrix.backend }}); then
@@ -78,7 +78,7 @@ jobs:
         run: |
           moon update
           $failed_directories = @()
-          Get-ChildItem -Path ".\examples" -Directory | ForEach-Object {
+          Get-ChildItem -Path ".\legacy\examples" -Directory | ForEach-Object {
             Write-Output "Processing $($_.FullName)"
             Set-Location $_.FullName
             moon install && moon check --target ${{ matrix.backend }} && moon test --target ${{ matrix.backend }}

.github/workflows/release.yml

@@ -0,0 +1,40 @@
+name: release website
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  en-build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: install
+        run: |
+          pnpm install
+      - name: build
+        run: |
+          cd moonbit-docs
+          pnpm build -l en
+      - name: upload
+        run: |
+          aws s3 sync --delete ./build/ ${{secrets.AWS_S3_BUCKET}}
+          aws cloudfront create-invalidation --distribution-id ${{secrets.AWS_CLOUDFRONT_DISTRIBUTION_ID}} --paths "/*"
+
+  zh-build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: install
+        run: |
+          pnpm install
+      - name: build
+        run: |
+          cd moonbit-docs
+          pnpm build -l zh
+      - name: upload
+        run: |
+          aliyun oss sync ./build/ ${{secrets.ALIYUN_OSS_BUCKET}} --force --delete
+          aliyun cdn RefreshObjectCaches --ObjectPath https://docs.moonbitlang.cn/ --ObjectType Directory

.github/workflows/website-check.yml

@@ -0,0 +1,22 @@
+name: check website
+
+on:
+  pull_request:
+    branches: main
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 9
+      - name: install
+        run: |
+          pnpm install
+      - name: check
+        run: |
+          cd moonbit-docs
+          pnpm typecheck
+          pnpm build

.gitignore

@@ -1,3 +1,24 @@
-.vscode
-target
+# Dependencies
+/node_modules
 
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+/.idea
+.npmrc
+/packages/rehypeshiki/node_modules
+/moonbit-docs/node_modules

.prettierignore

@@ -0,0 +1,11 @@
+static
+moonbit-docs/languages
+packages
+**/pnpm-lock.yaml
+**/.git
+**/node_modules
+**/.gitignore
+**/data
+**/build
+**/.docusaurus
+legacy

.prettierrc

@@ -0,0 +1,21 @@
+{
+  "arrowParens": "always",
+  "bracketSameLine": false,
+  "bracketSpacing": true,
+  "embeddedLanguageFormatting": "auto",
+  "endOfLine": "lf",
+  "htmlWhitespaceSensitivity": "css",
+  "insertPragma": false,
+  "jsxSingleQuote": true,
+  "printWidth": 80,
+  "proseWrap": "preserve",
+  "quoteProps": "as-needed",
+  "requirePragma": false,
+  "semi": false,
+  "singleAttributePerLine": false,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "none",
+  "useTabs": false,
+  "vueIndentScriptAndStyle": false
+}

CONTRIBUTING.md

@@ -1,11 +1,10 @@
 # Contributing Guidelines
 
-*Pull requests, bug reports, and all other forms of contribution are welcomed and highly encouraged!*
+_Pull requests, bug reports, and all other forms of contribution are welcomed and highly encouraged!_
 
 ## :bulb: Asking Questions
 
-See our forum([EN](https://discuss.moonbitlang.com/)/[ZH](https://taolun.moonbitlang.cn/)). In short, GitHub issues are not the appropriate place to debug your specific project, but should be reserved for filing bugs and feature requests.
-
+See our forum([EN](https://discuss.moonbitlang.com/)/[ZH](https://taolun.moonbitlang.com/)). In short, GitHub issues are not the appropriate place to debug your specific project, but should be reserved for filing bugs and feature requests.
 
 ## :inbox_tray: Opening an Issue
 

LICENSE.md

@@ -15,3 +15,8 @@ All prose content added before July 4, 2024 are copyright reserved.
 
 Code examples and snippets are available under
 [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt)
+
+## License for website code
+
+Website code are available under
+[Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt)

READEM-zh.md

@@ -0,0 +1,47 @@
+# MoonBit 文档网站
+
+该仓库存储MoonBit的文档网站[docs.moonbitlang.cn](https://docs.moonbitlang.cn)
+
+## 如何开始
+
+我们使用[Docusaurus 3](https://docusaurus.io/)开发这个网站
+
+### 安装
+
+```bash
+pnpm install
+```
+
+由于我们使用了pnpm workspace, 网站相关的代码在 `moonbit-docs` 文件夹下，所以请确保接下来的命令在 `moonbit-docs` 文件夹下执行。如果您不了解如何更改文件夹，请执行：
+
+```bash
+cd moonbit-docs
+```
+
+### 本地开发
+
+```
+pnpm start -l zh
+```
+
+这个命令会启动一个本地的开发服务器并打开一个浏览器窗口。大部分改动不需要重启服务器即可实时反映出来。
+
+### 预览
+
+```
+pnpm build -l zh && pnpm serve
+```
+
+这个命令会完成一次生产级构建并启动一个本地服务器来预览它。
+
+## 如何撰写文档
+
+### 修改已有的文档
+
+文档相关的 markdown 文件保存在`moonbit-docs/i18n/zh/docusaurus-plugin-content-docs/current`文件夹下。
+
+### 增加新的文档
+
+1. 在 `moonbit-docs/i18n/zh/docusaurus-plugin-content-docs/current` 文件夹下增加新的文档文件
+1. 在 `moonbit-docs/docs`文件夹下增加对应的英文文档文件，如果您不了解英文，可以只留一个占位的文件。
+1. 在 `moonbit-docs/sidebars.ts`文件中更新sidebar