saturneric/standard-readme
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
A standard style for README files
11 Commits 3 Branches 0 Tags 159 KiB
Shell 100%
feature/lint-title
Go to file
Richard Littauer 4ccb64561b Lint-title stuff
2016-05-13 15:30:44 -04:00
.gitignore Initial commit 2015-10-16 16:35:17 -04:00
.remarkrc Lint-title stuff 2016-05-13 15:30:44 -04:00
index.js Lint-title stuff 2016-05-13 15:30:44 -04:00
LICENSE Initial commit 2015-10-16 16:35:17 -04:00
package.json Lint-title stuff 2016-05-13 15:30:44 -04:00
README.md Lint-title stuff 2016-05-13 15:30:44 -04:00

README.md

readme-standard

Standardize all IPFS Readme.md's and other markdown files

This repo is for standardizing how readmes should look for IPFS.

Usage

The settings are stored in the .remarkrc file. Ideally, this file should be added to each repository where you plan to use remark. There are plans to enable a single .remarkrc to be used in multiple repos.

> npm i -g remark
> npm i
> remark README.md -o README.md

Contribute

Feel free to dive in! Open an issue or submit PRs.

License

MIT (c) Protocol Labs