Setup Stardards Headers Navigation API Documentation Testing Cites & Thanks
Readmes are used to describe the contents of code repositories. Besides the title, description, and code directory, readmes are the first thing users see. This boilerplate contains items to assist in writing readmes.
Install Heartly Readme Boilerplate
npm i heartly-readme-boilerplate --save-dev
Copy DEFAULT_README.md
npx copy-heartly-default-readme
Edit DEFAULT_README.md
to work as needed.
The standard section is the core section of the readme-boilerplate. It contains definitions and context for the rest of the readme-boiler-plate.
Headers for readme
's should include a title h1
, a sub-description h5
, and a description p
. After the header, the readme should contains sections that contain titles h2
and sub-titles h3
.
The readme boiler plate writes out the title with the h1
tag rather than markdown
so that the element is centered using the align
attribute once marky-markdown issue 404 is fixed.
<h1>This a header 💕</h1>
The pre-description is added before a full description. It is written on like this so that the element can be centered (see here for why it is not currently).
<h5>This is a pre-description</h5>
The description should describe the product. It follows and linebreak ---
.
---
A description
All together, this is a header that can be copied.
<h1 align="center">This a header 💕</h1>
<h5 align="center"This is a pre-description</h5>
---
A description
Navigation can be provided if the is more than 1 section to a readme
or document
. Navigation links to sections within the readme
and document
.
Here is how navigation is written.
<p align="center">
<a href="#section">section</a>
<a href="#section">section</a>
<a href="#section">section</a>
</p>
There is more than 1 way to approach API documentation. For smaller APIs, readmes can document APIs using tables or lists.
Name | Default | Description |
---|---|---|
initiate | function(){} |
it is initiated |
start | function(){} |
it is started |
| Name | Default | Description |
|---|---|---|
| initiate | `function(){}` | it is initiated |
| start | `function(){}` | it is started |
- API
- initiate:
f
function(){}
- example: an example
- a description
- start:
f
function(){}
- example: an example
- a description
- initiate:
- **API**
- **initiate:** `f`
- `function(){}`
- _example:_ an example
- a description
- **start:** `f`
- `function(){}`
- _example:_ an example
- a description
Currently readme render testing is manual.
- Github Github renderer via Elijah Insua
- NPM's marky-markdown renderer via Revin Guillen
Contributing guidelines can define how to file issues, contributors, submitting pull requests, and defining how
The Heartly project is a set of lists and tools to help make the online code discussions more friendly. It moves forward with inspiration from discussions with Brian Gonzalez, Jason Farmer, Patrick Fisher, and Arjan Singh.