![]() There's a rate limit: at the time of writing, 60 requests per hour. ![]() The HTML file uses the GitHub API to render the Markdown in a README.md file. To preview a readme, I browse github/readme.html, specifying the repo in the query string: Alternatively, you can copy the readme.html into the same directory as the README.md, and omit the query string: If the readme.html is in the same directory as README.md, you don't even need to serve readme.html over HTTP: you can just open it directly from your file system. The github directory contains the "preview" HTML file. I keep local copies of my GitHub repositories in sibling directories under a "github" directory.Įach repo directory contains a README.md file. High fidelity: use GitHub to render the Markdown, and same CSS.No locally hosted server-side processing (for example, no PHP). ![]() I looked at several existing options, but decided to roll my own to meet the following requirements: I use a locally hosted HTML file to preview GitHub readmes. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |