Skip to content

Commit 9484d49

Browse files
committed
WIP
1 parent 153160d commit 9484d49

File tree

4 files changed

+13
-10
lines changed

4 files changed

+13
-10
lines changed

.github/workflows/dokka.yml renamed to .github/workflows/docs.yml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Simple workflow for deploying static content to GitHub Pages
2-
name: Build Dokka Page
2+
name: Build Docs Page
33

44
on:
55
# Only run this workflow manually from the Actions tab
@@ -30,15 +30,19 @@ jobs:
3030
java-version: '21'
3131
- name: Setup Gradle
3232
uses: gradle/actions/setup-gradle@v4
33-
- name: Build Dokka
33+
- name: Build Docs
3434
run: |
3535
./gradlew :miuix:dokkaGenerate
36+
mv ./miuix/build/dokka/html/* ./miuix/docs/public/dokka
37+
cd ./docs
38+
yarn install
39+
yarn docs:build
3640
- name: Setup Pages
3741
uses: actions/configure-pages@v5
3842
- name: Upload artifact
3943
uses: actions/upload-pages-artifact@v3
4044
with:
41-
path: ./miuix/build/dokka/html
45+
path: ./miuix/docs/.vitepress/dist
4246

4347
deploy:
4448
environment:

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,5 @@ xcuserdata
1313
convention-plugins/bin
1414
docs/node_modules
1515
docs/.vitepress/dist
16-
docs/.vitepress/cache
16+
docs/.vitepress/cache
17+
/docs/public/dokka

docs/.vitepress/config.mts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
import { defineConfig } from 'vitepress'
22

33
export default defineConfig({
4-
base: '/docs/',
4+
base: '/',
55

66
title: "Miuix",
77

88
description: "A UI library for Compose MultiPlatform",
99

1010
head: [
11-
['link', { rel: 'icon', href: '/docs/Icon.webp' }],
11+
['link', { rel: 'icon', href: '/Icon.webp' }],
1212
['link', { rel: 'preconnect', href: 'https://cdn-font.hyperos.mi.com/font/css?family=MiSans_VF:VF:Chinese_Simplify,Latin&display=swap' }],
1313
],
1414

docs/guide/getting-started.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,5 @@ Scaffold(
100100
Scaffold 组件为跨平台提供了一个合适的弹出窗口的容器。`SuperDialog``SuperDropdown``SuperSpinner``ListPopup` 等组件都基于此实现弹出窗口,因此都需要被该组件包裹。
101101
:::
102102

103-
## 下一步
104-
105-
- 查看[组件库](/components/index)了解所有可用组件
106-
- 浏览[示例应用](https://github.com/YuKongA/miuix-kotlin-multiplatform/tree/main/example)获取实际使用案例
103+
## API 文档
104+
- 查看 [API 文档](/dokka/index.html){target="_blank"},此文档使用 Dokka 生成,包含了所有 API 的详细信息。

0 commit comments

Comments
 (0)