generator-short-documentation

yeoman-generator for HTML template projects that provides easy documentation. This project makes use of Pug, SCSS, and TypeScript.

Usage no npm install needed!

<script type="module">
  import generatorShortDocumentation from 'https://cdn.skypack.dev/generator-short-documentation';
</script>

README

Short Documentation (Yeoman Generator)

Yeoman generator for the Short Documentation project.

Short Documentation is an HTML template & documentation build tool.

The code organization and naming convention allow for a documentation build with minimal effort. Short Documentation uses Pug, SCSS, and TypeScript, and uses a configuration file to jump start project development (by building out all the files and folders as defined in the JSON file).

License

The code is available under the MIT license.