satwikkansal / Readme_styles
Licence: unlicense
Minimal README.rst and README.md template for Github projects.
Stars: ✭ 60
Projects that are alternatives of or similar to Readme styles
Format Readme
Формат файла README
Stars: ✭ 270 (+350%)
Mutual labels: readme, markdown, restructuredtext
Badges
📝 Markdown code for lots of small badges 🎀 📌 (shields.io, forthebadge.com etc) 😎. Contributions are welcome! Please add yours!
Stars: ✭ 2,987 (+4878.33%)
Mutual labels: markdown, restructuredtext, badges
prathimacode-hub
Hello everyone, Welcome to my GitHub README profile. Glad to see you here! Check out this repository to view my work and learn more about me. Don't just star it, fork it as well.📢✌️
Stars: ✭ 53 (-11.67%)
Mutual labels: readme, badges
Waliki
A wiki engine powered by Django and Git
Stars: ✭ 300 (+400%)
Mutual labels: markdown, restructuredtext
Github Markdown Toc.go
Easy TOC creation for GitHub README.md (in go)
Stars: ✭ 387 (+545%)
Mutual labels: readme, markdown
Vectorlogozone
3,000+ gorgeous SVG logos, perfect for your README or credits page
Stars: ✭ 239 (+298.33%)
Mutual labels: readme, logo
autobadge
Simple CLI tool to generate essential repository badges with ease
Stars: ✭ 16 (-73.33%)
Mutual labels: readme, badges
Pytablewriter
pytablewriter is a Python library to write a table in various formats: CSV / Elasticsearch / HTML / JavaScript / JSON / LaTeX / LDJSON / LTSV / Markdown / MediaWiki / NumPy / Excel / Pandas / Python / reStructuredText / SQLite / TOML / TSV.
Stars: ✭ 422 (+603.33%)
Mutual labels: markdown, restructuredtext
Redpen
RedPen is an open source proofreading tool to check if your technical documents meet the writing standard. RedPen supports various markup text formats (Markdown, Textile, AsciiDoc, Re:VIEW, reStructuredText and LaTeX).
Stars: ✭ 466 (+676.67%)
Mutual labels: markdown, restructuredtext
Markdown Magic
💫 Automatically format markdown files, sync external docs/src code & make better docs
Stars: ✭ 551 (+818.33%)
Mutual labels: readme, markdown
Github Profilinator
🚀 This tool contains mini GUI components that you can hook together to automatically generate markdown code for a perfect readme.
Stars: ✭ 225 (+275%)
Mutual labels: readme, markdown
Markdown readme
Markdown - you can mark up titles, lists, tables, etc., in a much cleaner, readable and accurate way if you do it with HTML.
Stars: ✭ 146 (+143.33%)
Mutual labels: readme, markdown
Goreadme
Generate readme file from Go doc. Now available with Github actions!
Stars: ✭ 113 (+88.33%)
Mutual labels: readme, markdown
Jsdoc To Markdown
Generate markdown documentation from jsdoc-annotated javascript
Stars: ✭ 1,199 (+1898.33%)
Mutual labels: readme, markdown
Badges4 Readme.md Profile
👩💻👨💻 Improve your README.md profile with these amazing badges.
Stars: ✭ 929 (+1448.33%)
Mutual labels: readme, badges
Emacs Easy Hugo
Emacs major mode for managing hugo
Stars: ✭ 235 (+291.67%)
Mutual labels: markdown, restructuredtext
Markdown Toc
Generate a markdown TOC (table of contents) for a README or any markdown files, using remarkable. Used by assemble, verb, and lots of other projects on GitHub. API and CLI.
Stars: ✭ 1,185 (+1875%)
Mutual labels: readme, markdown
Github Profile Readme Generator
🚀 Generate GitHub profile README easily with the latest add-ons like visitors count, GitHub stats, etc using minimal UI.
Stars: ✭ 7,812 (+12920%)
Mutual labels: readme, markdown
// Header Design 1
Project Name
A one line description of the project.
// Header Design 2
Project Name
One line description of the project.
// Repo badges
// Project Logo
// or ASCII Art
_____ _ _
| __ \ | | | |
| |__) | ___ __ _ __| | _ __ ___ ___ | |
| _ / / _ \ / _` | / _` | | '_ ` _ \ / _ \ | |
| | \ \ | __/ | (_| | | (_| | | | | | | | | __/ |_|
|_| \_\ \___| \__,_| \__,_| |_| |_| |_| \___| (_)
// Project Video
// Body
Table of Contents
- Prerequisites
- Installation
- Usage
- Contributing
- Acknowldegements
- Raw templates: Markdown and reStructuredText
- Some Useful Links
Prerequisites
Mention what things one needs to install the software and how to install them.
Add commands and links required.
Installation
Operating System:
> commands to install the project
Another OS:
$ commands to install the project
Usage
Basic usage instructions to help people to just get started using your project.
For more examples and usage, please refer to the Wiki.
Contributing
All patches welcome! Please read CONTRIBUTING.md for further details.
License
LICENSE NAME - see the LICENSE file for more details.
// or
Acknowledgements
- Inspiration
- People who helped
- References to code reused
That's all folks!
Raw version in the Markdown and reStructuredText format are available below
Markdown
// Header Design 1
<h1 align="center">Project Name</h1>
<p align="center">A one line description of the project.</p>
<p align="center"><a >Check It Out!</a> | <a >Read the Docs</a></p>
// Header Design 2
# Project Name
> One line description of the project.
// Repo badges
[![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome) [![Travis Build Status](https://travis-ci.org/{ORG-or-USERNAME}/{REPO-NAME}.png?branch=master)](https://travis-ci.org/{ORG-or-USERNAME}/{REPO-NAME}) [![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/%7B%7Bstatus_id%7D%7D)](https://ci.appveyor.com/project/%7B%7Busername%7D%7D/%7B%7Bproject_name%7D%7D) [![Join the chat at https://gitter.im/{ORG-or-USERNAME}/{REPO-NAME}](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dwyl/?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![GitHub forks](https://img.shields.io/github/forks/satwikkansal/readme_styles.svg?style=social&label=Fork)](https://github.com/{USERNAME}/{REPO-NAME}) [![GitHub stars](https://img.shields.io/github/stars/{USERNAME}/{REPO-NAME}.svg?style=social&label=Star)](https://github.com/readme_styles) [![GitHub tag](https://img.shields.io/github/tag/{USERNAME}/{REPO-NAME}.svg)](https://github.com/{USERNAME}/{REPO-NAME})
[![GitHub release](https://img.shields.io/github/release/{USERNAME}/{REPO-NAME}.svg)](https://github.com/{USERNAME}/{REPO-NAME})
// Project Logo
![logo](PROJECT_LOGO_URL)
// or ASCII Art
```
_____ _ _
| __ \ | | | |
| |__) | ___ __ _ __| | _ __ ___ ___ | |
| _ / / _ \ / _` | / _` | | '_ ` _ \ / _ \ | |
| | \ \ | __/ | (_| | | (_| | | | | | | | | __/ |_|
|_| \_\ \___| \__,_| \__,_| |_| |_| |_| \___| (_)
```
// Project Video
[![vido_thumbnail](https://c1.staticflickr.com/3/2154/2054140257_58e87296b6.jpg)](PROJECT_VIDEO_URL)
// Body
## Table of Contents
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [Acknowldegements](#acknowledgements)
## Prerequisites
Mention what things you need to install the software and how to install them.
```
Add commands and links required.
```
## Installation
Operating System:
```sh
> commands to install the project
```
Another OS:
```sh
$ commands to install the project
```
## Usage
Basic usage instructions to help people to just get started using your project.
For more examples and usage, please refer to the [Wiki](https://github.com/yourname/yourproject/wiki).
## Contributing
All patches welcome! Please read [CONTRIBUTING.md](https://github.com/{USERNAME}/{REPO-NAME}/blob/master/CONTRIBUTING.md) for furthers details.
## License
LICENSE NAME - see the [LICENSE](https://github.com/satwikkansal/readme_styles/blob/master/LICENSE) file for details
// or
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
## Acknowledgements
- Inspiration
- People who helped
- References to code reused
reStructuredText
Converted from the above markdown using pandoc:
::
// Header Design 1
<h1 align="center">Project Name</h1>
<p align="center">A one line description of the project.</p>
<p align="center"><a >Check It Out!</a> | <a >Read the Docs</a></p>
// Header Design 2
# Project Name
> One line description of the project.
// Repo badges
[![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome) [![Travis Build Status](https://travis-ci.org/{ORG-or-USERNAME}/{REPO-NAME}.png?branch=master)](https://travis-ci.org/{ORG-or-USERNAME}/{REPO-NAME}) [![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/%7B%7Bstatus_id%7D%7D)](https://ci.appveyor.com/project/%7B%7Busername%7D%7D/%7B%7Bproject_name%7D%7D) [![Join the chat at https://gitter.im/{ORG-or-USERNAME}/{REPO-NAME}](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dwyl/?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![GitHub forks](https://img.shields.io/github/forks/satwikkansal/readme_styles.svg?style=social&label=Fork)](https://github.com/{USERNAME}/{REPO-NAME}) [![GitHub stars](https://img.shields.io/github/stars/{USERNAME}/{REPO-NAME}.svg?style=social&label=Star)](https://github.com/readme_styles) [![GitHub tag](https://img.shields.io/github/tag/{USERNAME}/{REPO-NAME}.svg)](https://github.com/{USERNAME}/{REPO-NAME})
[![GitHub release](https://img.shields.io/github/release/{USERNAME}/{REPO-NAME}.svg)](https://github.com/{USERNAME}/{REPO-NAME})
// Project Logo
![logo](PROJECT_LOGO_URL)
// or ASCII Art
```
_____ _ _
| __ \ | | | |
| |__) | ___ __ _ __| | _ __ ___ ___ | |
| _ / / _ \ / _` | / _` | | '_ ` _ \ / _ \ | |
| | \ \ | __/ | (_| | | (_| | | | | | | | | __/ |_|
|_| \_\ \___| \__,_| \__,_| |_| |_| |_| \___| (_)
```
// Project Video
[![vido_thumbnail](https://c1.staticflickr.com/3/2154/2054140257_58e87296b6.jpg)](PROJECT_VIDEO_URL)
// Body
## Table of Contents
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [Acknowldegements](#acknowledgements)
## Prerequisites
Mention what things you need to install the software and how to install them.
```
Add commands and links required.
```
## Installation
Operating System:
```sh
> commands to install the project
```
Another OS:
```sh
$ commands to install the project
```
## Usage
Basic usage instructions to help people to just get started using your project.
For more examples and usage, please refer to the [Wiki](https://github.com/yourname/yourproject/wiki).
## Contributing
All patches welcome! Please read [CONTRIBUTING.md](https://github.com/{USERNAME}/{REPO-NAME}/blob/master/CONTRIBUTING.md) for furthers details.
## License
LICENSE NAME - see the [LICENSE](https://github.com/satwikkansal/readme_styles/blob/master/LICENSE) file for details
// or
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
## Acknowledgements
- Inspiration
- People who helped
- References to code reused
Some Useful links
- Repo Badges: https://github.com/dwyl/repo-badges and https://github.com/bevacqua/awesome-badges
- Create ASCII art from text: http://patorjk.com/software/taag/
- License Badges: https://gist.github.com/lukas-h/2a5d00690736b4c3a7ba
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].