Skip to content

Commit

Permalink
docs: initialize vitepress (#45)
Browse files Browse the repository at this point in the history
  • Loading branch information
fu050409 authored Jul 16, 2024
1 parent a924470 commit aa61aa8
Show file tree
Hide file tree
Showing 7 changed files with 636 additions and 2 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,7 @@ dist-ssr

# Unplugin
components.d.ts

# Vitepress
docs/.vitepress/dist
docs/.vitepress/cache
3 changes: 2 additions & 1 deletion cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
"toastservice",
"unocss",
"unplugin",
"usetoast"
"usetoast",
"vitepress"
],
"ignorePaths": [
// Tauri files
Expand Down
37 changes: 37 additions & 0 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
import { defineConfig } from 'vitepress';

// https://vitepress.dev/reference/site-config
export default defineConfig({
lang: 'en-US',
title: 'Grassator',
description: 'Secure, modern and fast multi-process downloader',
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
logo: '/logo.png',

nav: [{ text: 'Home', link: '/' }],

sidebar: [],

socialLinks: [
{ icon: 'github', link: 'https://github.com/noctisynth/Grassator' },
],

footer: {
message:
'Released under the <a href="https://github.com/noctisynth/Grassator/blob/main/LICENSE-MIT">MIT License</a> and <a href="https://github.com/noctisynth/Grassator/blob/main/LICENSE-AGPL">AGPLv3 License</a>.',
copyright:
'Copyright © 2011-present <a href="https://github.com/noctisynth">Noctisynth, Inc.</a>',
},
},
locales: {
root: {
label: 'English',
lang: 'en-US',
},
zh: {
label: '简体中文',
lang: 'zh-CN',
},
},
});
19 changes: 19 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
# https://vitepress.dev/reference/default-theme-home-page
layout: home

hero:
name: "Grassator"
text: "Secure, modern and fast multi-process downloader"
tagline:
actions:
- theme: brand
text: Get Started
- theme: alt
text: Download

features:
- title: Nothing here yet
details: We are working on this project and will update this section soon.
---

18 changes: 18 additions & 0 deletions docs/zh/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
# https://vitepress.dev/reference/default-theme-home-page
layout: home

hero:
name: 'Grassator'
text: '安全,现代和快速的多进程下载器'
tagline:
actions:
- theme: brand
text: 开始
- theme: alt
text: 下载

features:
- title: 尚未完成
details: 我们正努力开发这个项目,稍后将更新本部分内容。
---
6 changes: 5 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@
"build": "vue-tsc --noEmit && vite build",
"preview": "vite preview",
"tauri": "tauri",
"bump": "node scripts/bump.mjs"
"bump": "node scripts/bump.mjs",
"docs:dev": "vitepress dev docs",
"docs:build": "vitepress build docs",
"docs:preview": "vitepress preview docs"
},
"dependencies": {
"@primevue/themes": "^4.0.0",
Expand All @@ -35,6 +38,7 @@
"unplugin-turbo-console": "^1.9.5",
"unplugin-vue-components": "^0.27.2",
"vite": "^5.3.3",
"vitepress": "^1.3.1",
"vue-tsc": "^2.0.26"
},
"lint-staged": {
Expand Down
Loading

0 comments on commit aa61aa8

Please sign in to comment.