vanrose
v0.1.0
Published
Supplementary tool for Vandoc
Downloads
4
Readme
Vanrose
Van Helsing used to put Wild Roses on coffins to immobilize vampires. Now, the times have changed. Put Vanrose on hunted docs objects, to empower them.
Supplementary tool for Vandoc.
- Accepts Vandoc result object
- Provides handy methods to work with object
So far it is only initial draft.
Methods
const v = vanrose(vandocData, { cwd: '/source' })
v.filterLanguage('languageName')
— returns entries only for specified language.v.toc()
— returns Object with Table of Content based on inner values with appropriate links for each entry, taking into accountcwd
.v.href(':module/path')
— creates properhref
fromNamepath
which can be used for anchors.