Git Product home page Git Product logo

documentation-boilerplate's Introduction

Welcome to documentation boilerplate ๐Ÿ‘‹

โ€”โ€” Personal prefered common documentation boilerplate โ€”โ€”

๐ŸŒ English | ็ฎ€ไฝ“ไธญๆ–‡

๐Ÿ”จ Usage

1. Use Templates

Some personal prefered common documentation boilerplate:

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:

demo

Generated README.md:

cli output

๐Ÿ’ก 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

๐ŸŽˆ Further to documentation, not just Readme

๐Ÿ“ License

MIT License.

Copyright ยฉ 2020 NNNaix.

documentation-boilerplate's People

Contributors

nnnaix avatar

Stargazers

avatar

Watchers

avatar avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.