1.3.1 • Published 4 years ago
@datev/vuepress-offlinesearch-parse-cli v1.3.1
Vuepress-documents-parser-cli
This script parses markdown files, from an Vuepress project, into a json file in ./.vuepress/public/document.json
as needed by the
vuepress-pugin-offlinesearch to build its search index.
Usage
- Add the plugin as dependency:
npm i @datev/vuepress-offlinesearch-parse-cli
After that you just type this into the console.
npm run generate-documents
The following json structure will be built:
[
{
"pageTitle": "exampleTitle",
"sectionHeader": "ExampleHeader",
"sectionSlug": "/exampleSite.html#exampleSection",
"sectionContent": "This is example content"
}
]
Contributing
Contributions are welcome !
If you want to contribute or have a question please just open a new issue.