All Projects → cezaraugusto → Github Template Guidelines

cezaraugusto / Github Template Guidelines

Guidelines for building GitHub templates.

Projects that are alternatives of or similar to Github Template Guidelines

Docma
A powerful tool to easily generate beautiful HTML documentation from JavaScript (JSDoc), Markdown and HTML files.
Stars: ✭ 287 (+109.49%)
Mutual labels:  documentation, docs, reference
Learn
👩‍🏫 Learn how to use RunwayML with tutorials, guides, and examples!
Stars: ✭ 95 (-30.66%)
Mutual labels:  documentation, docs, guidelines
Docs
Documentation of Vercel and other services
Stars: ✭ 663 (+383.94%)
Mutual labels:  documentation, docs, guidelines
Doc
🦋 Raku documentation (tools and docs)
Stars: ✭ 259 (+89.05%)
Mutual labels:  documentation, docs, reference
Pyspark Cheatsheet
🐍 Quick reference guide to common patterns & functions in PySpark.
Stars: ✭ 108 (-21.17%)
Mutual labels:  documentation, docs, reference
The Documentation Compendium
📢 Various README templates & tips on writing high-quality documentation that people want to read.
Stars: ✭ 4,306 (+3043.07%)
Mutual labels:  documentation, docs, guidelines
Jsdoc Baseline
An experimental, extensible template for JSDoc.
Stars: ✭ 51 (-62.77%)
Mutual labels:  documentation, docs, template
Zeal
Offline documentation browser inspired by Dash
Stars: ✭ 9,164 (+6589.05%)
Mutual labels:  documentation, docs
Wazuh Documentation
Wazuh - Project documentation
Stars: ✭ 82 (-40.15%)
Mutual labels:  documentation, reference
Docpht
With DocPHT you can take notes and quickly document anything and without the use of any database.
Stars: ✭ 90 (-34.31%)
Mutual labels:  documentation, docs
Jekyll Rtd Theme
Just another documentation theme compatible with GitHub Pages
Stars: ✭ 92 (-32.85%)
Mutual labels:  documentation, docs
Foliant
Comprehensive markdown-based documentation toolkit
Stars: ✭ 74 (-45.99%)
Mutual labels:  documentation, docs
Checklist Tools Website
🍿 The perfect Checklist Website for meticulous developers.
Stars: ✭ 73 (-46.72%)
Mutual labels:  reference, guidelines
Community
Modern Confluence alternative designed for internal & external docs, built with Golang + EmberJS
Stars: ✭ 1,286 (+838.69%)
Mutual labels:  documentation, docs
Docnado
Rapid documentation tool that will blow you away...
Stars: ✭ 67 (-51.09%)
Mutual labels:  documentation, docs
Quickstart
🎯 A micro-form for user-specific installation instructions
Stars: ✭ 66 (-51.82%)
Mutual labels:  documentation, docs
Gatsby Documentation Starter
Automatically generate docs for React components using MDX, react-docgen, and GatsbyJS
Stars: ✭ 91 (-33.58%)
Mutual labels:  documentation, docs
Reference En
Editable source for the Arduino Reference
Stars: ✭ 97 (-29.2%)
Mutual labels:  docs, reference
Ikea Tradfri Coap Docs
How can you communicate to your ikea tradfri gateway/hub through coap-client
Stars: ✭ 111 (-18.98%)
Mutual labels:  documentation, docs
Catalog
Create living style guides using Markdown or React
Stars: ✭ 1,527 (+1014.6%)
Mutual labels:  documentation, docs

Short description (one line) about what this project stands for.

Under Development Public Domain Travis

Short project's overview (one paragraph) explaining what this project stands for. Using this boilerplate, three lines is a good length for briefly explaining this project's purpose while respecting the base layout. 👽



Installing

[?] So, how users can get this project up and running on their machines?

# Describe it in a nice way. Code samples with installation basics works great
$ npm install --global ghdocs
$ ghdocs

Getting Started

[?] What does this project stands for?

Usage

[?] Tell contributors how to use it.

Contributing

[?] Write some Contributing guidelines or a Contributors list (or both!). Like:

Please read CONTRIBUTING.md for more details.

or if you like it simple:

  1. Fork this repository
  2. Create a branch
  3. Commit your changes
  4. Push your commits to the branch
  5. Submit a pull request

You can find more information about Pull Requests here

Check also the list of contributors who helped on this project.

Changelog 📝

[?] Write here a link for your CHANGELOG file. It's also commonly called HISTORY.

Acknowledgments 👍

[?] Reference someone's code you used, insert an external link or thank people, i.e.:

  • Shields.io. Definitely a must-have.
  • Travis-CI. Another must-have. Test and Deploy with Confidence.

To-Do 👨

[?] If your project is still in an early release, a to-do list is a good thing to keep track:

  • [x] Include something
  • [ ] Another something
  • [ ] So on...

License

[?] Include a refence for the license you choosed. For this project my take was the Public License. More licenses here.

CC0

To the extent possible under law, YOUR_NAME_HERE has waived all copyright and related or neighboring rights to this work.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].