readme_styles

KO | EN

gitlite — search

#javascript #hacktoberfest #react #typescript #machine-learning #macos #nodejs #windows #awesome #cli #awesome-list #vue #openai #open-source

(★ 67)

Minimal README.rst and README.md template for Github projects.

readme_styles Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

// Header Design 1

<h1 align="center">Project Name</h1>

<p align="center">A one line description of the project.</p>

<p align="center"><a href="#site">Check It Out!</a> | <a href="#documentation">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/satwikkansal/readme_styles) [![GitHub stars](https://img.shields.io/github/stars/satwikkansal/readme_styles.svg?style=social&label=Star)](https://github.com/readme_styles) [![GitHub tag](https://img.shields.io/github/tag/satwikkansal/readme_styles.svg)](https://github.com/satwikkansal/readme_styles)
[![GitHub release](https://img.shields.io/github/release/satwikkansal/readme_styles.svg)](https://github.com/satwikkansal/readme_styles)

// Project Logo

![logo](https://upload.wikimedia.org/wikipedia/commons/5/59/Logo-Logo.svg)

// or ASCII Art

```
  _____                       _                        _ 
 |  __ \                     | |                      | |
 | |__) |   ___    __ _    __| |    _ __ ___     ___  | |
 |  _  /   / _ \  / _` |  / _` |   | '_ ` _ \   / _ \ | |
 | | \ \  |  __/ | (_| | | (_| |   | | | | | | |  __/ |_|
 |_|  \_\  \___|  \__,_|  \__,_|   |_| |_| |_|  \___| (_)
                                                         
                                                         
 ```

// Project Video

[![vido_thumbnail](https://c1.staticflickr.com/3/2154/2054140257_58e87296b6.jpg)](https://www.youtube.com/watch?v=SjORe3_2bQc)

// Body

## Table of Contents

- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [Acknowldegements](#acknowledgements)
- **Raw templates:** [Markdown](#markdown) and [reStructuredText](#restructuredtext)
- [Some Useful Links](#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:

```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/satwikkansal/readme_styles/blob/master/CONTRIBUTING.md) for further details.

## License

LICENSE NAME - see the [LICENSE](https://github.com/satwikkansal/readme_styles/blob/master/LICENSE) file for more 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

---

<h2 align="center"> That's all folks!</h2>
<p align="center">Raw version in the Markdown and reStructuredText format are available below</p>

#### 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 href="#site">Check It Out!</a> | <a href="#documentation">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](https://raw.githubusercontent.com/satwikkansal/readme_styles/master/PROJECT_LOGO_URL)

// or ASCII Art

```
      _____                       _                        _ 
     |  __ \                     | |                      | |
     | |__) |   ___    __ _    __| |    _ __ ___     ___  | |
     |  _  /   / _ \  / _` |  / _` |   | '_ ` _ \   / _ \ | |
     | | \ \  |  __/ | (_| | | (_| |   | | | | | | |  __/ |_|
     |_|  \_\  \___|  \__,_|  \__,_|   |_| |_| |_|  \___| (_)

```

// Project Video

[![vido_thumbnail](https://c1.staticflickr.com/3/2154/2054140257_58e87296b6.jpg)](https://raw.githubusercontent.com/satwikkansal/readme_styles/master/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](https://pandoc.org/try/):
```
::

// Header Design 1

<h1 align="center">Project Name</h1>

<p align="center">A one line description of the project.</p>

<p align="center"><a href="#site">Check It Out!</a> | <a href="#documentation">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](https://raw.githubusercontent.com/satwikkansal/readme_styles/master/PROJECT_LOGO_URL)

// or ASCII Art

```

// Project Video

[![vido_thumbnail](https://c1.staticflickr.com/3/2154/2054140257_58e87296b6.jpg)](https://raw.githubusercontent.com/satwikkansal/readme_styles/master/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

readme_styles

readme_styles Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

readme_styles

readme_styles Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README