Package Exports
- @enterthenamehere/esdoc-integrate-manual-plugin
- @enterthenamehere/esdoc-integrate-manual-plugin/src/Plugin.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@enterthenamehere/esdoc-integrate-manual-plugin) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
ESDoc Integrate Manual Plugin
Use with updated EnterTheNameHere/esdoc-monorepo. Original esdoc is here.
Install
npm install @enterthenamehere/esdoc-integrate-manual-plugin
Config
{
"source": "./src",
"destination": "./doc",
"plugins": [
{
"name": "@enterthenamehere/esdoc-integrate-manual-plugin",
"option": {
"index": "./manual/index.md",
"globalIndex": false,
"asset": "./manual/asset",
"files": [
"./manual/overview.md",
"./manual/design.md",
"./manual/installation.md",
"./manual/usage1.md",
"./manual/usage2.md",
"./manual/tutorial.md",
"./manual/configuration.md",
"./manual/example.md",
"./manual/advanced.md",
"./manual/faq.md",
"./CHANGELOG.md"
]
}
}
]
}
index
is default readme.md
globalIndex
is default false
asset
is default null
- can be directory to copy
files
is default []
- array of files making manual pages
LICENSE
MIT