docs: add docs package (#16515)

This adds an @ionic/docs package that we can use to publish the
JSON API data along with each release.
This commit is contained in:
Cam Wiegert
2018-11-29 15:10:35 -06:00
committed by GitHub
parent f0e0ac876d
commit ab84f31443
4 changed files with 31 additions and 0 deletions

View File

@@ -62,6 +62,10 @@ export const config: Config = {
type: 'docs',
strict: true
},
{
type: 'docs-json',
file: '../docs/core.json'
},
{
type: 'stats',
file: 'stats.json'

1
docs/.gitignore vendored Normal file
View File

@@ -0,0 +1 @@
core.json

7
docs/README.md Normal file
View File

@@ -0,0 +1,7 @@
# @ionic/docs
This package publishes the JSON data used to build the [Ionic API documentation](https://beta.ionicframework.com/docs/api).
## License
* [MIT](https://raw.githubusercontent.com/ionic-team/ionic/master/LICENSE)

19
docs/package.json Normal file
View File

@@ -0,0 +1,19 @@
{
"name": "@ionic/docs",
"version": "4.0.0-beta.17",
"description": "Pre-packaged API documentation for the Ionic docs.",
"main": "core.json",
"files": [
"core.json"
],
"author": "Ionic Team",
"license": "MIT",
"repository": {
"type": "git",
"url": "git+https://github.com/ionic-team/ionic-docs.git"
},
"bugs": {
"url": "https://github.com/ionic-team/ionic-docs/issues"
},
"homepage": "https://github.com/ionic-team/ionic-docs#readme"
}