Skip to content

Commit a7b3a45

Browse files
lijy91lijy91
authored
Merge pull request #256 from fastforgedev/docs
Refactoring the documentation site based on VitePress
2 parents 7d90f46 + 299d948 commit a7b3a45

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

88 files changed

+4368
-5936
lines changed

‎.gitignore

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

77
pubspec_overrides.yaml
88
pubspec.lock
9+
.vercel

‎.vercelignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.dart_tool/
2+
.idea/
3+
examples/
4+
packages/
5+
*.iml

‎docs/.gitignore

+142
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
lerna-debug.log*
8+
.pnpm-debug.log*
9+
10+
# Diagnostic reports (https://nodejs.org/api/report.html)
11+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
12+
13+
# Runtime data
14+
pids
15+
*.pid
16+
*.seed
17+
*.pid.lock
18+
19+
# Directory for instrumented libs generated by jscoverage/JSCover
20+
lib-cov
21+
22+
# Coverage directory used by tools like istanbul
23+
coverage
24+
*.lcov
25+
26+
# nyc test coverage
27+
.nyc_output
28+
29+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
30+
.grunt
31+
32+
# Bower dependency directory (https://bower.io/)
33+
bower_components
34+
35+
# node-waf configuration
36+
.lock-wscript
37+
38+
# Compiled binary addons (https://nodejs.org/api/addons.html)
39+
build/Release
40+
41+
# Dependency directories
42+
node_modules/
43+
jspm_packages/
44+
45+
# Snowpack dependency directory (https://snowpack.dev/)
46+
web_modules/
47+
48+
# TypeScript cache
49+
*.tsbuildinfo
50+
51+
# Optional npm cache directory
52+
.npm
53+
54+
# Optional eslint cache
55+
.eslintcache
56+
57+
# Optional stylelint cache
58+
.stylelintcache
59+
60+
# Microbundle cache
61+
.rpt2_cache/
62+
.rts2_cache_cjs/
63+
.rts2_cache_es/
64+
.rts2_cache_umd/
65+
66+
# Optional REPL history
67+
.node_repl_history
68+
69+
# Output of 'npm pack'
70+
*.tgz
71+
72+
# Yarn Integrity file
73+
.yarn-integrity
74+
75+
# dotenv environment variable files
76+
.env
77+
.env.development.local
78+
.env.test.local
79+
.env.production.local
80+
.env.local
81+
82+
# parcel-bundler cache (https://parceljs.org/)
83+
.cache
84+
.parcel-cache
85+
86+
# Next.js build output
87+
.next
88+
out
89+
90+
# Nuxt.js build / generate output
91+
.nuxt
92+
dist
93+
94+
# Gatsby files
95+
.cache/
96+
# Comment in the public line in if your project uses Gatsby and not Next.js
97+
# https://nextjs.org/blog/next-9-1#public-directory-support
98+
# public
99+
100+
# vuepress build output
101+
.vuepress/dist
102+
103+
# vuepress v2.x temp and cache directory
104+
.temp
105+
.cache
106+
107+
# vitepress build output
108+
**/.vitepress/dist
109+
110+
# vitepress cache directory
111+
**/.vitepress/cache
112+
113+
# Docusaurus cache and generated files
114+
.docusaurus
115+
116+
# Serverless directories
117+
.serverless/
118+
119+
# FuseBox cache
120+
.fusebox/
121+
122+
# DynamoDB Local files
123+
.dynamodb/
124+
125+
# TernJS port file
126+
.tern-port
127+
128+
# Stores VSCode versions used for testing VSCode extensions
129+
.vscode-test
130+
131+
# yarn v2
132+
.yarn/cache
133+
.yarn/unplugged
134+
.yarn/build-state.yml
135+
.yarn/install-state.gz
136+
.pnp.*
137+
138+
# vitepress cache
139+
**/.vitepress/cache
140+
141+
# vitepress dist
142+
**/.vitepress/dist

‎docs/.postcssrc.json

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"plugins": {
3+
"postcss-rtlcss": {
4+
"ltrPrefix": ":where([dir=\"ltr\"])",
5+
"rtlPrefix": ":where([dir=\"rtl\"])"
6+
}
7+
}
8+
}

‎docs/.prettierrc

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"printWidth": 70,
3+
"trailingComma": "es5",
4+
"tabWidth": 2,
5+
"semi": false,
6+
"singleQuote": true,
7+
"jsxSingleQuote": true,
8+
"endOfLine": "lf"
9+
}

‎docs/.vitepress/config/en.ts

+95
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
import { defineConfig, type DefaultTheme } from 'vitepress'
2+
3+
export const en = defineConfig({
4+
lang: 'en-US',
5+
description: 'Make your app distribution with ease.',
6+
7+
themeConfig: {
8+
nav: nav(),
9+
10+
sidebar: {
11+
'/': { base: '', items: sidebarGuide() },
12+
},
13+
14+
editLink: {
15+
pattern:
16+
'https://github.com/fastforgedev/fastforge/edit/main/docs/:path',
17+
text: 'Edit this page on GitHub',
18+
},
19+
20+
footer: {
21+
message: 'Released under the MIT License.',
22+
copyright: 'Copyright © 2021-present LiJianying',
23+
},
24+
},
25+
})
26+
27+
function nav(): DefaultTheme.NavItem[] {
28+
return [
29+
{
30+
text: 'Guide',
31+
link: '/getting-started',
32+
activeMatch: '/getting-started',
33+
},
34+
]
35+
}
36+
37+
function sidebarGuide(): DefaultTheme.SidebarItem[] {
38+
return [
39+
{
40+
text: 'Guide',
41+
collapsed: false,
42+
items: [
43+
{ text: 'Getting Started', link: 'getting-started' },
44+
{ text: 'Distribute Options', link: 'distribute-options' },
45+
{ text: 'CLI', link: 'cli' },
46+
],
47+
},
48+
{
49+
text: '制作器',
50+
collapsed: false,
51+
items: [
52+
{ text: 'aab', link: '/makers/aab/' },
53+
{ text: 'apk', link: '/makers/apk/' },
54+
{ text: 'appimage', link: '/makers/appimage/' },
55+
{ text: 'deb', link: '/makers/deb/' },
56+
{ text: 'dmg', link: '/makers/dmg/' },
57+
{ text: 'exe', link: '/makers/exe/' },
58+
{ text: 'ipa', link: '/makers/ipa/' },
59+
{ text: 'msix', link: '/makers/msix/' },
60+
{ text: 'pkg', link: '/makers/pkg/' },
61+
{ text: 'rpm', link: '/makers/rpm/' },
62+
{ text: 'zip', link: '/makers/zip/' },
63+
],
64+
},
65+
{
66+
text: '发布器',
67+
collapsed: false,
68+
items: [
69+
{ text: 'appcenter', link: '/publishers/appcenter/' },
70+
{ text: 'appstore', link: '/publishers/appstore/' },
71+
{ text: 'fir', link: '/publishers/fir/' },
72+
{
73+
text: 'firebase-hosting',
74+
link: '/publishers/firebase-hosting/',
75+
},
76+
{ text: 'firebase', link: '/publishers/firebase/' },
77+
{ text: 'github', link: '/publishers/github/' },
78+
{ text: 'pgyer', link: '/publishers/pgyer/' },
79+
{ text: 'playstore', link: '/publishers/playstore/' },
80+
{ text: 'qiniu', link: '/publishers/qiniu/' },
81+
{ text: 'vercel', link: '/publishers/vercel/' },
82+
],
83+
},
84+
{
85+
text: 'Tools',
86+
collapsed: false,
87+
items: [
88+
{
89+
text: 'Parse App Package',
90+
link: '/tools/parse-app-package/',
91+
},
92+
],
93+
},
94+
]
95+
}

‎docs/.vitepress/config/index.ts

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
import { defineConfig } from 'vitepress'
2+
import { shared } from './shared'
3+
import { en } from './en'
4+
import { zh } from './zh'
5+
6+
export default defineConfig({
7+
...shared,
8+
locales: {
9+
root: { label: 'English', ...en },
10+
zh: { label: '简体中文', ...zh },
11+
},
12+
})

0 commit comments

Comments
 (0)