@lamnhan/ayedocs

A Docs-o-matic document generator for Typescript projects.

Usage no npm install needed!

<script type="module">
  import lamnhanAyedocs from 'https://cdn.skypack.dev/@lamnhan/ayedocs';
</script>

README

Install & usage

Install as a global CLI: npm install -g @lamnhan/ayedocs. Or locally using the --save-dev flag.

You may want to put a script in the package.json, so you can do npm run docs every build.

{
  "scripts": {
    "docs": "ayedocs generate"
  }
}

See the documentation at: https://lamnhan.com/ayedocs

What & how?

@lamnhan/ayedocs is mainly used to extract content & generate document from a Typescript source code, you start by providing instructions in the configuration.

An example configuration:

module.exports = {
  fileRender: {
    'README.md': {
      head: true,
      lib: ["Lib", "FULL"]
      license: true
    }
  }
}

With the above config, you can run ayedocs generate, the result will be a README.md file with 3 sections as described in the config. Simple that is!

See some useful use cases to see if it fits your need.

License

@lamnhan/ayedocs is released under the MIT license.

⚡️ This document is generated automatically using @lamnhan/ayedocs.