@patternplate/load-docs
TypeScript icon, indicating that this package has built-in type declarations

3.1.1 • Public • Published

Documentation and development interface for component libraries

@patternplate/load-docs

  • Framework independent
  • Bring design docs to live with real components
  • Powerful search and meta data system

This is the contributor documentation for @patternplate/cli For user docs see patternplate.github.io

About @patternplate/load-docs

Load documentation files matching a glob pattern.

Quick start

git clone https://github.com/patternplate/patternplate.git
cd patternplate/packages/load-docs
yarn
yarn start

Usage

const loadDocs = require("@patternplate/load-doc");
const {loadDocsTree} = loadDocs;

(async () => {
  const doc = await loadDocs({docs: ["**/*.md"]});

  const tree = await loadDocsTree({docs: ["**/*.md"]});
})();

License

Copyright by SinnerSchrader. All @patternplate packages are released under the MIT license.

Readme

Keywords

none

Package Sidebar

Install

npm i @patternplate/load-docs

Weekly Downloads

2

Version

3.1.1

License

MIT

Unpacked Size

10 kB

Total Files

9

Last publish

Collaborators

  • kotzendekrabbe
  • lkuechler
  • rongae
  • marionebl