Narcissistic, Perfectly Modest

    @patternplate/load-doc
    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-doc

    • 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-doc

    Provided a current working directory @patternplate/load-doc return the Buffer holding the conntents of README.md, readme.md or index.md.

    Quick start

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

    Usage

    const { loadDoc } = require("@patternplate/load-doc");
    
    (async () => {
      const doc = await loadDoc({cwd: process.cwd()});
      // {filepath: null | "string", contents: null | Buffer)
    })();

    License

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

    Keywords

    none

    Install

    npm i @patternplate/load-doc

    DownloadsWeekly Downloads

    264

    Version

    3.1.1

    License

    MIT

    Unpacked Size

    6.01 kB

    Total Files

    9

    Last publish

    Collaborators

    • kotzendekrabbe
    • lkuechler
    • rongae
    • marionebl