Skip to content

Commit

Permalink
docs: updates
Browse files Browse the repository at this point in the history
  • Loading branch information
kazupon committed Nov 24, 2020
1 parent 3f9cdae commit 724f1c1
Show file tree
Hide file tree
Showing 9 changed files with 151 additions and 202 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
dist
docs/api/vue-i18**
docs/api/
types
temp
coverage
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,14 @@ If you use stable Vue I18n version, see this [repository](https://github.com/kaz

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

- [createI18n](https://vue-i18n-next.intlify.dev/api/vue-i18n-function.html#createi18n)
- [I18nOptions](https://vue-i18n-next.intlify.dev/api/vue-i18n-typealias.html#i18noptions)
- [ComposerOptions](https://vue-i18n-next.intlify.dev/api/vue-i18n-interface.html#composeroptions)
- [VueI18nOptions](https://vue-i18n-next.intlify.dev/api/vue-i18n-interface.html#vuei18noptions)
- [useI18n](https://vue-i18n-next.intlify.dev/api/vue-i18n-function.html#usei18n)
- [ComposerOptions](https://vue-i18n-next.intlify.dev/api/vue-i18n-interface.html#composeroptions)
- [Composer](https://vue-i18n-next.intlify.dev/api/vue-i18n-interface.html#composer)
- [VueI18n](https://vue-i18n-next.intlify.dev/api/vue-i18n-interface.html#vuei18n)
- [createI18n](https://vue-i18n-next.intlify.dev/api/general.html#createi18n)
- [I18nOptions](https://vue-i18n-next.intlify.dev/api/general.html#i18noptions)
- [ComposerOptions](https://vue-i18n-next.intlify.dev/api/composition.html#composeroptions)
- [VueI18nOptions](https://vue-i18n-next.intlify.dev/api/legacy.html#vuei18noptions)
- [useI18n](https://vue-i18n-next.intlify.dev/api/compositiono.html#usei18n)
- [ComposerOptions](https://vue-i18n-next.intlify.dev/api/compositino.html#composeroptions)
- [Composer](https://vue-i18n-next.intlify.dev/api/composition.html#composer)
- [VueI18n](https://vue-i18n-next.intlify.dev/api/legacy.html#vuei18n)

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

Expand Down
54 changes: 15 additions & 39 deletions docs/.vitepress/config.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
const { readdirSync } = require('fs')
const { resolve, basename } = require('path')

/** @typedef {import('vitepress').UserConfig} UserConfig */

/** @type {UserConfig['head']} */
Expand Down Expand Up @@ -36,8 +33,7 @@ const config = {
},
{
text: 'API Reference',
link: '/api/'
//link: '/api/vue-i18n-general'
link: '/api/general'
},
{
text: 'Chnagelog',
Expand Down Expand Up @@ -145,44 +141,24 @@ const config = {
link: '/v8-docs',
},
],
'/api/': getSidebarApi('vue-i18n'),
// '/api/': [
// {
// text: 'General',
// link: '/api/vue-i18n-general'
// },
// {
// text: 'Legacy API',
// link: '/api/vue-i18n-legacy'
// },
// {
// text: 'Composition API',
// link: '/api/vue-i18n-composition'
// }
// ]
'/api/': [
{
text: 'General',
link: '/api/general'
},
{
text: 'Legacy API',
link: '/api/legacy'
},
{
text: 'Composition API',
link: '/api/composition'
}
]
}
}
}
}
}

function getSidebarApi(target) {
const API_TITLE_MAPS = {
function: 'Functions',
interface: 'Interfaces',
typealias: 'Type Aliases',
variable: 'Variables',
class: 'Classes'
}
return readdirSync(resolve(__dirname, '../api'))
.map(file => basename(file, '.md'))
.filter(file => file.includes(target))
.map(file => {
return {
text: API_TITLE_MAPS[file.split('-').pop()],
link: `/api/${file}`
}
})
}

module.exports = config
1 change: 0 additions & 1 deletion docs/api/index.md

This file was deleted.

7 changes: 7 additions & 0 deletions docsgen.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
const linkReferencer = require('./scripts/api/resolver')
const processor = require('./scripts/api/processor')

module.exports = {
linkReferencer,
processor
}
3 changes: 1 addition & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -152,8 +152,7 @@
"clean:type": "rm -rf ./types/** ./temp ./dist/vue-i18n.d.ts",
"coverage": "opener coverage/lcov-report/index.html",
"dev:e2e": "jest --runInBand --config ./jest.e2e.config.js",
"docs:apigen": "api-docs-gen ./temp/vue-i18n.api.json -o ./docs/api",
"docs:apigen1": "api-docs-gen ./temp/vue-i18n.api.json -o ./docs/api -c ./scripts/docsgen.config.js --tsdoc-config ./tsdoc.json",
"docs:apigen": "api-docs-gen ./temp/vue-i18n.api.json -o ./docs/api -c ./docsgen.config.js -g noprefix -t ./tsdoc.json",
"docs:build": "yarn docs:setup && vitepress build docs",
"docs:dev": "vitepress dev docs",
"docs:serve": "vitepress serve docs",
Expand Down
Loading

0 comments on commit 724f1c1

Please sign in to comment.