NNNaix / documentation-boilerplate

Personal prefered common documentation boilerplate

Welcome to documentation boilerplate 👋

—— Personal prefered common documentation boilerplate ——

🌐 English | 简体中文

🔨 Usage

1. Use Templates

Some personal prefered common documentation boilerplate:

• Readme
• Pull Request
• Issue

2. Use CLI

Some CLI tools for auto generating document files.

Readme

readme-md-generator will suggest you default answers by reading your package.json and git configuration

Process Demo:

Generated README.md:

💡 Guides

• Make a Reademe - A guide to writing READMEs. Includes an editable template with live Markdown rendering.
• Art of Readme - For even more background, wisdom, and ideas

🗃️ Other Templates

• Readme
  • Awesome Readme
  • Standard Readme

🎈 Further to documentation, not just Readme

• The Documentation Compendium - A guide to writing high-quality documentation about:
  • README
  • Pull Request
  • Issues
  • Contributing
  • Code of Conduct
  • Coding Guidelines
  • Codebase Structure
  • Changelog
  • TODO

📝 License

MIT License.

Copyright © 2020 NNNaix.