gulp-docgen4node-readme

A Gulp plugin to generate README documentation from templates.

⚠ Warning ! Work in progress...

Table of Contents

• Synopsis
• Usage
• Installation
• API Reference
• Tests
  • Run unit tests
• Build
  • Documentation
    • Generate README
    • Generation API reference
• Compatibility
  • Node
  • Browser
• Issues
• Contributing
• Credits
• History
• License

Synopsis

A Gulp plugin to generate README documentation from templates.

Usage

const gulp = require('gulp')
const docgen4NodeReadme = require('gulp-docgen4node-readme')

// Generate a README.md from default templates.
gulp.task('doc_readme', () => {
  return docgen4NodeReadme.to('README.md')
    .pipe(gulp.dest('./')
})

Installation

npm install gulp-docgen4-node-readme

API Reference

Please refer to API documentation hosted by Read the Docs.

Tests

Run unit tests

npm test

Build

Documentation

Generate README

Be careful! :

• README is generated using a settings file and templates provided by gulp-docgen4node-readme.
• Please only modify related settings.
• Then you can generate documentation using the following command:

  npm run docgen_readme

Generate API documentation

The API documentation is automatically generated using Read the Docs.

Compatibility

Node

• Tested with Node 9.

Browser

N/A

Issues

Feel free to submit issues and enhancement requests.

Contributing

Please refer to project's style guidelines and guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.

1. Fork the repo on GitHub
2. Clone the project to your own machine
3. Commit changes to your own branch
4. Push your work back up to your fork
5. Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

Credits

Thanks to the developers of the very useful dependencies...

• Nunjucks by James Long, Copyright (c) 2012-2015, James Long, BSD License.
• current-git-branch by Jan Peer Stöcklmair, Copyright (c) 2016 Jan Peer Stöcklmair, MIT License.

History

Please refer to the changelog file.

License

The MIT License

Copyright (c) 2018 SAS 9 Février

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.