Skip to content

Commit 7c11bea

Browse files
committed
refactor: rebuild using docs.stella-api.dev
1 parent 2e33980 commit 7c11bea

28 files changed

+5144
-2620
lines changed

.env.example

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
2+
# Create one with no scope selected on https://github.com/settings/tokens/new
3+
GITHUB_TOKEN=

.github/workflows/deploy.yml

+5-2
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,12 @@ jobs:
3333

3434
- name: Building Pages
3535
run: yarn build
36+
37+
- name: Generating Pages
38+
run: yarn generate
3639

3740
- name: Add Commit Hashes
38-
run: git rev-parse HEAD > ./src/.vuepress/COMMIT
41+
run: git rev-parse HEAD > ./dist/COMMIT
3942

4043
- name: Publish into GitHub Pages
4144
uses: crazy-max/[email protected]
@@ -45,7 +48,7 @@ jobs:
4548
# Create incremental commit instead of doing push force
4649
keep_history: true
4750
# Build directory to deploy
48-
build_dir: "./src/.vuepress/dist"
51+
build_dir: "./dist"
4952
# The committer name and email address
5053
committer: "Stella IT Bot <[email protected]>"
5154
# The author name and email address

.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,6 @@ node_modules
66

77
# Static builds
88
src/.vuepress/dist
9+
.nuxt
10+
dist
11+
sw.*

src/getting-started/README.md renamed to content/en/getting-started/README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
# Getting started
2-
3-
## Welcome to Stella API!
1+
---
2+
title: Let's get started.
3+
description: Learn how to use Stella API.
4+
position: 2
5+
category: 'Getting started'
6+
---
47
Stella API is a API for Developers to develop applications utilizing Stella IT's service/platforms.
58
With Stella API, You can control your VM and access various information provided by Stella IT and its services.
69

content/en/index.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: Welcome!
3+
description: Welcome to Stella API Docs!
4+
position: 1
5+
category: ''
6+
---
7+
8+
Welcome to Stella API Docs.
9+
This Docs is provided under Open Source, you can freely edit on GitHub!
10+

src/locales/ko/getting-started/README.md renamed to content/ko/getting-started/README.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
# 빠른시작 가이드
2-
3-
## Stella API에 오신 것을 환영합니다.
4-
1+
---
2+
title: 개발을 시작해 볼까요?
3+
description: Stella API를 통해 개발하는 방법을 배워봅니다.
4+
position: 2
5+
category: 빠른시작 가이드
6+
---
57
Stella API는 Stella IT의 서비스를 개발자분들께서 직접 프로그래밍을 통해 조작할 수 있도록 제작된 시스템입니다.
68

79
## 계정 생성

content/ko/index.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: 환영합니다!
3+
description: Stella IT Docs에 오신걸 환영합니다.
4+
position: 1
5+
category: ''
6+
---
7+
8+
Stella API Docs에 오신 것을 환영합니다.
9+
본 문서는 OpenSource로 제공되고 있습니다, GitHub에서 문서를 수정하거나 작성하실 수 있습니다!

content/settings.json

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"title": "Stella IT API Docs",
3+
"url": "https://docs.stella-api.dev",
4+
"logo": {
5+
"light": "/logo-light.svg",
6+
"dark": "/logo-dark.svg"
7+
},
8+
"github": "Stella-IT/docs.stella-api.dev",
9+
"twitter": ""
10+
}

locales/en-US.js

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
export default {
2+
search: {
3+
placeholder: 'Search from Docs (Press "/")'
4+
},
5+
toc: {
6+
title: 'Table of Contents'
7+
},
8+
article: {
9+
github: 'Edit this page on GitHub',
10+
updatedAt: 'Last Updated: '
11+
}
12+
}

locales/ko-KR.js

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
export default {
2+
search: {
3+
placeholder: '전체 문서에서 검색하기("/" 누르고 입력)'
4+
},
5+
toc: {
6+
title: '목차'
7+
},
8+
article: {
9+
github: 'GitHub에서 현재 페이지 수정하기',
10+
updatedAt: '최종 업데이트: '
11+
}
12+
}

nuxt.config.js

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
import theme from '@nuxt/content-theme-docs'
2+
3+
export default theme({
4+
docs: {
5+
primaryColor: '#00a8ff'
6+
},
7+
8+
i18n: {
9+
locales: () => [{
10+
code: 'ko',
11+
iso: 'ko-KR',
12+
file: 'ko-KR.js',
13+
name: '한국어'
14+
}, {
15+
code: 'en',
16+
iso: 'en-US',
17+
file: 'en-US.js',
18+
name: 'English'
19+
}],
20+
langDir: '../../../../locales/',
21+
defaultLocale: 'en'
22+
},
23+
})

package.json

+7-8
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,16 @@
77
"name": "Stella IT Developers",
88
"email": "[email protected]"
99
},
10-
"repository": "https://github.com/Stella-IT/docs.stella-api.dev/docs.stella-api.dev",
10+
"repository": "https://github.com/Stella-IT/docs.stella-api.dev",
1111
"scripts": {
12-
"dev": "vuepress dev src",
13-
"build": "vuepress build src"
12+
"dev": "nuxt",
13+
"build": "nuxt build",
14+
"start": "nuxt start",
15+
"generate": "nuxt generate"
1416
},
1517
"license": "MIT",
16-
"devDependencies": {
17-
"vuepress": "^1.5.3"
18-
},
1918
"dependencies": {
20-
"vuepress-auto-sidebar": "^1.1.1",
21-
"vuepress-theme-default-prefers-color-scheme": "^2.0.0"
19+
"@nuxt/content-theme-docs": "^0.9.0",
20+
"nuxt": "^2.15.2"
2221
}
2322
}

src/.vuepress/components/Foo/Bar.vue

-15
This file was deleted.

src/.vuepress/components/OtherComponent.vue

-3
This file was deleted.

src/.vuepress/components/demo-component.vue

-15
This file was deleted.

src/.vuepress/config.js

-110
This file was deleted.

src/.vuepress/enhanceApp.js

-14
This file was deleted.

src/.vuepress/styles/index.styl

-8
This file was deleted.

src/.vuepress/styles/palette.styl

-10
This file was deleted.

src/index.md

-11
This file was deleted.

src/locales/ko/guide/README.md

-5
This file was deleted.

src/locales/ko/index.md

-11
This file was deleted.

static/icon.png

10.7 KB
Loading

0 commit comments

Comments
 (0)