Guides: README Formatting
You can make your README formatted by putting README with specific extension.
Supported Formats
| format | extension |
|---|---|
| rdoc | README.rdoc |
| Markdown | README.markdown, README.md, README.mdown, README.mkd, README.mkdn |
| Textile | README.textile |
| PNG | README.png (will display the image) |
| reStructuredText | README.rst |
| (no formatting) | README.* (all but above extensions), README (no extension) |
Unsupported Formats
- rd (README.rd)
Notes
- If there is both README and README.foo, README.foo is displayed.
- feature request: format READMEs without an extension
- feature request: POD
- feature request: AsciiDoc
- reStructuredText: there are certain, specific kinds of content that will cause the .rst renderer to fail. In particular, certain non-latin unicode glyphs will cause README.rst’s to not render on github while rendering perfectly happily using rst2html.py. If your README.rst will not render, try looking for unusual content in your .rst and stripping it out, and seeing if that has an effect.
Last edited by ssokolow, 10 days ago
Versions:
