Skip to content

Commit 724f1c1

Browse files
committed
docs: updates
1 parent 3f9cdae commit 724f1c1

File tree

9 files changed

+151
-202
lines changed

9 files changed

+151
-202
lines changed

.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
dist
2-
docs/api/vue-i18**
2+
docs/api/
33
types
44
temp
55
coverage

README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,14 @@ If you use stable Vue I18n version, see this [repository](https://github.com/kaz
5454

5555
New style API for Vue Composition API. See the following docs:
5656

57-
- [createI18n](https://vue-i18n-next.intlify.dev/api/vue-i18n-function.html#createi18n)
58-
- [I18nOptions](https://vue-i18n-next.intlify.dev/api/vue-i18n-typealias.html#i18noptions)
59-
- [ComposerOptions](https://vue-i18n-next.intlify.dev/api/vue-i18n-interface.html#composeroptions)
60-
- [VueI18nOptions](https://vue-i18n-next.intlify.dev/api/vue-i18n-interface.html#vuei18noptions)
61-
- [useI18n](https://vue-i18n-next.intlify.dev/api/vue-i18n-function.html#usei18n)
62-
- [ComposerOptions](https://vue-i18n-next.intlify.dev/api/vue-i18n-interface.html#composeroptions)
63-
- [Composer](https://vue-i18n-next.intlify.dev/api/vue-i18n-interface.html#composer)
64-
- [VueI18n](https://vue-i18n-next.intlify.dev/api/vue-i18n-interface.html#vuei18n)
57+
- [createI18n](https://vue-i18n-next.intlify.dev/api/general.html#createi18n)
58+
- [I18nOptions](https://vue-i18n-next.intlify.dev/api/general.html#i18noptions)
59+
- [ComposerOptions](https://vue-i18n-next.intlify.dev/api/composition.html#composeroptions)
60+
- [VueI18nOptions](https://vue-i18n-next.intlify.dev/api/legacy.html#vuei18noptions)
61+
- [useI18n](https://vue-i18n-next.intlify.dev/api/compositiono.html#usei18n)
62+
- [ComposerOptions](https://vue-i18n-next.intlify.dev/api/compositino.html#composeroptions)
63+
- [Composer](https://vue-i18n-next.intlify.dev/api/composition.html#composer)
64+
- [VueI18n](https://vue-i18n-next.intlify.dev/api/legacy.html#vuei18n)
6565

6666
### `<i18n-t>` Component (formerly called `<i18n>` component)
6767

docs/.vitepress/config.js

+15-39
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
const { readdirSync } = require('fs')
2-
const { resolve, basename } = require('path')
3-
41
/** @typedef {import('vitepress').UserConfig} UserConfig */
52

63
/** @type {UserConfig['head']} */
@@ -36,8 +33,7 @@ const config = {
3633
},
3734
{
3835
text: 'API Reference',
39-
link: '/api/'
40-
//link: '/api/vue-i18n-general'
36+
link: '/api/general'
4137
},
4238
{
4339
text: 'Chnagelog',
@@ -145,44 +141,24 @@ const config = {
145141
link: '/v8-docs',
146142
},
147143
],
148-
'/api/': getSidebarApi('vue-i18n'),
149-
// '/api/': [
150-
// {
151-
// text: 'General',
152-
// link: '/api/vue-i18n-general'
153-
// },
154-
// {
155-
// text: 'Legacy API',
156-
// link: '/api/vue-i18n-legacy'
157-
// },
158-
// {
159-
// text: 'Composition API',
160-
// link: '/api/vue-i18n-composition'
161-
// }
162-
// ]
144+
'/api/': [
145+
{
146+
text: 'General',
147+
link: '/api/general'
148+
},
149+
{
150+
text: 'Legacy API',
151+
link: '/api/legacy'
152+
},
153+
{
154+
text: 'Composition API',
155+
link: '/api/composition'
156+
}
157+
]
163158
}
164159
}
165160
}
166161
}
167162
}
168163

169-
function getSidebarApi(target) {
170-
const API_TITLE_MAPS = {
171-
function: 'Functions',
172-
interface: 'Interfaces',
173-
typealias: 'Type Aliases',
174-
variable: 'Variables',
175-
class: 'Classes'
176-
}
177-
return readdirSync(resolve(__dirname, '../api'))
178-
.map(file => basename(file, '.md'))
179-
.filter(file => file.includes(target))
180-
.map(file => {
181-
return {
182-
text: API_TITLE_MAPS[file.split('-').pop()],
183-
link: `/api/${file}`
184-
}
185-
})
186-
}
187-
188164
module.exports = config

docs/api/index.md

-1
This file was deleted.

docsgen.config.js

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
const linkReferencer = require('./scripts/api/resolver')
2+
const processor = require('./scripts/api/processor')
3+
4+
module.exports = {
5+
linkReferencer,
6+
processor
7+
}

package.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -152,8 +152,7 @@
152152
"clean:type": "rm -rf ./types/** ./temp ./dist/vue-i18n.d.ts",
153153
"coverage": "opener coverage/lcov-report/index.html",
154154
"dev:e2e": "jest --runInBand --config ./jest.e2e.config.js",
155-
"docs:apigen": "api-docs-gen ./temp/vue-i18n.api.json -o ./docs/api",
156-
"docs:apigen1": "api-docs-gen ./temp/vue-i18n.api.json -o ./docs/api -c ./scripts/docsgen.config.js --tsdoc-config ./tsdoc.json",
155+
"docs:apigen": "api-docs-gen ./temp/vue-i18n.api.json -o ./docs/api -c ./docsgen.config.js -g noprefix -t ./tsdoc.json",
157156
"docs:build": "yarn docs:setup && vitepress build docs",
158157
"docs:dev": "vitepress dev docs",
159158
"docs:serve": "vitepress serve docs",

0 commit comments

Comments
 (0)