| CARVIEW |
Select Language
HTTP/2 302
server: nginx
date: Tue, 26 Aug 2025 12:13:17 GMT
content-type: text/plain; charset=utf-8
content-length: 0
x-archive-redirect-reason: found capture at 20100311143551
location: https://web.archive.org/web/20100311143551/https://github.com/guides/readme-formatting
server-timing: captures_list;dur=0.782127, exclusion.robots;dur=0.027053, exclusion.robots.policy;dur=0.011729, esindex;dur=0.013165, cdx.remote;dur=157.331442, LoadShardBlock;dur=296.505114, PetaboxLoader3.datanode;dur=119.320082, PetaboxLoader3.resolve;dur=111.361656
x-app-server: wwwb-app213
x-ts: 302
x-tr: 534
server-timing: TR;dur=0,Tw;dur=0,Tc;dur=0
set-cookie: wb-p-SERVER=wwwb-app213; path=/
x-location: All
x-rl: 0
x-na: 0
x-page-cache: MISS
server-timing: MISS
x-nid: DigitalOcean
referrer-policy: no-referrer-when-downgrade
permissions-policy: interest-cohort=()
HTTP/2 200
server: nginx
date: Tue, 26 Aug 2025 12:13:19 GMT
content-type: text/html; charset=utf-8
x-archive-orig-server: nginx/0.7.61
x-archive-orig-date: Thu, 11 Mar 2010 14:35:50 GMT
x-archive-orig-connection: close
x-archive-orig-status: 200 OK
x-archive-orig-etag: "71887c41fe5e4bebc375434f639a78ba"
x-archive-orig-x-runtime: 125ms
x-archive-orig-content-length: 11720
x-archive-orig-cache-control: private, max-age=0, must-revalidate
x-archive-guessed-content-type: text/html
x-archive-guessed-charset: utf-8
memento-datetime: Thu, 11 Mar 2010 14:35:51 GMT
link: ; rel="original", ; rel="timemap"; type="application/link-format", ; rel="timegate", ; rel="first memento"; datetime="Thu, 31 Jul 2008 12:23:34 GMT", ; rel="prev memento"; datetime="Sat, 06 Feb 2010 14:50:44 GMT", ; rel="memento"; datetime="Thu, 11 Mar 2010 14:35:51 GMT", ; rel="next memento"; datetime="Sat, 29 May 2010 16:00:11 GMT", ; rel="last memento"; datetime="Mon, 07 Mar 2022 00:29:16 GMT"
content-security-policy: default-src 'self' 'unsafe-eval' 'unsafe-inline' data: blob: archive.org web.archive.org web-static.archive.org wayback-api.archive.org athena.archive.org analytics.archive.org pragma.archivelab.org wwwb-events.archive.org
x-archive-src: 51_14_20100311062623_crawl100_IndexOnly-c/51_14_20100311143506_crawl101.arc.gz
server-timing: captures_list;dur=0.543328, exclusion.robots;dur=0.018936, exclusion.robots.policy;dur=0.009323, esindex;dur=0.010902, cdx.remote;dur=54.834677, LoadShardBlock;dur=607.137002, PetaboxLoader3.datanode;dur=350.650834, PetaboxLoader3.resolve;dur=443.188941, load_resource;dur=284.994937
x-app-server: wwwb-app213
x-ts: 200
x-tr: 1000
server-timing: TR;dur=0,Tw;dur=0,Tc;dur=0
x-location: All
x-rl: 0
x-na: 0
x-page-cache: MISS
server-timing: MISS
x-nid: DigitalOcean
referrer-policy: no-referrer-when-downgrade
permissions-policy: interest-cohort=()
content-encoding: gzip
README Formatting - Guides - GitHub
Guides: README Formatting
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 |
| POD | README.pod |
| (no formatting) | README.* (all but above extensions), README (no extension) |
Unsupported Formats
- rd (README.rd)
- html (README.html — considered insecure)
Notes
- If there is both README and README.foo, README.foo is displayed.
- feature request: format READMEs without an extension
- feature request: AsciiDoc
- feature request: TiddlyWiki Syntax
- feature request: Something MediaWiki like such as MediaCloth or WikiCreole
- feature request: txt2tags
- feature request: org-mode
- 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.
- feature request: support i18n filename format like README_ja.txt
- feature request: HAML — https://haml-lang.com/ — *.(html)?.haml
Last edited by knoopx, about 1 month ago
Versions: