Eu uso um arquivo HTML hospedado localmente para visualizar os readmes do GitHub.
Examinei várias opções existentes, mas decidi criar minhas próprias para atender aos seguintes requisitos:
- Único arquivo
- URL hospedado localmente (intranet)
- Nenhuma extensão do navegador necessária
- Nenhum processamento hospedado localmente no servidor (por exemplo, sem PHP)
- Leve (por exemplo, sem jQuery)
- Alta fidelidade: use o GitHub para renderizar o Markdown e o mesmo CSS
Eu mantenho cópias locais dos meus repositórios GitHub em diretórios irmãos sob um diretório "github".
Cada diretório repo contém um arquivo README.md:
.../github/
repo-a/
README.md
repo-b/
README.md
etc.
O diretório github contém o arquivo HTML "preview":
.../github/
readme.html
Para visualizar um leia-me, eu navego no github / readme.html, especificando o repositório na string de consulta:
http://localhost/github/readme.html?repo-a
Como alternativa, você pode copiar o readme.html no mesmo diretório que o README.md e omitir a string de consulta:
http://localhost/github/repo-a/readme.html
Se o readme.html estiver no mesmo diretório que o README.md, você nem precisará fornecer o readme.html por HTTP: basta abri-lo diretamente do seu sistema de arquivos.
O arquivo HTML usa a API do GitHub para processar o Markdown em um arquivo README.md. Há um limite de taxa : no momento da redação, 60 solicitações por hora .
Funciona para mim nas versões atuais de produção do Chrome, IE e Firefox no Windows 7.
Fonte
Aqui está o arquivo HTML (readme.html):
<!DOCTYPE html>
<!--
Preview a GitHub README.md.
Either:
- Copy this file to a directory that contains repo directories,
and then specify a repo name in the query string.
For example:
http://localhost/github/readme.html?myrepo
or
- Copy this file to the directory that contains a README.md,
and then browse to this file without specifying a query string.
For example:
http://localhost/github/myrepo/readme.html
(or just open this file in your browser directly from
your file system, without HTTP)
-->
<html lang="en">
<head>
<meta charset="utf-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=Edge"/>
<meta name="author" content="Graham Hannington"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GitHub readme preview</title>
<link rel="stylesheet" type="text/css" href="http://primercss.io/docs.css"/>
<script type="text/javascript">
//<![CDATA[
var HTTP_STATUS_OK = 200;
var URL_API_GITHUB_RENDER_MARKDOWN = "https://api.github.com/markdown/raw";
var README_FILE_NAME = "README.md";
var readmeURL;
var queryString = location.search.substring(1);
if (queryString.length > 0) {
readmeURL = queryString + "/" + README_FILE_NAME;
} else {
readmeURL = README_FILE_NAME;
}
// Get Markdown, then render it as HTML
function getThenRenderMarkdown(markdownURL) {
var xhr = new XMLHttpRequest();
xhr.open("GET", markdownURL, true);
xhr.responseType = "text";
xhr.onload = function(e) {
if (this.status == HTTP_STATUS_OK) {
// Response text contains Markdown
renderMarkdown(this.responseText);
}
}
xhr.send();
}
// Use the GitHub API to render Markdown as HTML
function renderMarkdown(markdown) {
var xhr = new XMLHttpRequest();
xhr.open("POST", URL_API_GITHUB_RENDER_MARKDOWN, true);
xhr.responseType = "html";
xhr.onload = function(e) {
if (this.status == HTTP_STATUS_OK) {
document.getElementById("readme").innerHTML = this.response;
}
}
xhr.send(markdown);
}
window.onload = function() {
getThenRenderMarkdown(readmeURL);
}
//]]>
</script>
</head>
<body>
<header class="masthead">
<div class="container">
<span class="masthead-logo"><span class="mega-octicon
octicon-mark-github"></span>GitHub readme preview</span>
</div>
</header>
<div class="container">
<div id="readme" class="markdown-body">
<p>Rendering markdown, please wait...</p>
</div>
<footer class="footer">Rendering by
<a href="https://developer.github.com/v3/markdown/">GitHub</a>,
styling by <a href="http://primercss.io/">Primer</a>.</footer>
</div>
</body>
</html>
Notas do desenvolvedor
- Normalmente, envolvo meu código em um IIFE, mas, neste caso, não vi a necessidade e pensei em mantê-lo conciso
- Eu não me incomodei em apoiar o IE de nível anterior
- Por uma questão de concisão, omiti o código de tratamento de erros (você acredita em mim ?!)
- Gostaria de receber dicas de programação JavaScript
Ideias
- Estou pensando em criar um repositório GitHub para esse arquivo HTML e colocar o arquivo no ramo gh-pages, para que o GitHub o sirva como uma página da web "normal". Eu ajustaria o arquivo para aceitar uma URL completa - do README (ou qualquer outro arquivo Markdown) - como a string de consulta. Estou curioso para saber se a hospedagem do GitHub contornaria o limite de solicitações da API do GitHub e se ocorrer algum problema entre domínios (usando uma solicitação Ajax para obter o Markdown de um domínio diferente do domínio que serve a página HTML) .
Versão original (obsoleta)
Eu preservei esse registro da versão original por valor de curiosidade. Esta versão teve os seguintes problemas resolvidos na versão atual:
- Foi necessário o download de alguns arquivos relacionados
- Ele não suportava ser descartado no mesmo diretório que o arquivo README.md
- Seu HTML era mais quebradiço; mais suscetível a alterações no GitHub
O diretório github contém o arquivo HTML "preview" e os arquivos relacionados:
.../github/
readme-preview.html
github.css
github2.css
octicons.eot
octicons.svg
octicons.woff
Eu baixei os arquivos de fonte CSS e octicons do GitHub:
https://assets-cdn.github.com/assets/github- ... .css
https://assets-cdn.github.com/assets/github2- ... .css
https://github.com/static/fonts/octicons/octicons.* (eot, woff, svg)
Renomeei os arquivos CSS para omitir a longa sequência de dígitos hexadecimais nos nomes originais.
Editei o github.css para se referir às cópias locais dos arquivos de fontes octicons.
Examinei o HTML de uma página do GitHub e reproduzi o suficiente da estrutura HTML em torno do conteúdo leia-me para fornecer uma fidelidade razoável; por exemplo, a largura restrita.
O CSS do GitHub, a fonte octicons e o "contêiner" HTML para o conteúdo leia-me estão movendo destinos: vou precisar fazer o download periodicamente de novas versões.
Eu brinquei com o uso de CSS de vários projetos do GitHub. Por exemplo:
<link rel="stylesheet" type="text/css"
href="http://rawgit.com/sindresorhus/github-markdown-css/gh-pages/github-markdown.css">
mas finalmente decidiu usar o CSS do próprio GitHub.
Fonte
Aqui está o arquivo HTML (readme-preview.html):
<!DOCTYPE html>
<!-- Preview a GitHub README.md.
Copy this file to a directory that contains repo directories.
Specify a repo name in the query string. For example:
http://localhost/github/readme-preview.html?myrepo
-->
<html>
<head>
<title>Preview GitHub readme</title>
<meta http-equiv="X-UA-Compatible" content="IE=Edge"/>
<meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
<!-- Downloaded copies of the CSS files served by GitHub.
In github.css, the @font-face for font-family:'octicons'
has been edited to refer to local copies of the font files -->
<link rel="stylesheet" type="text/css" href="github.css"/>
<link rel="stylesheet" type="text/css" href="github2.css"/>
<style>
body {
margin-top: 1em;
}
</style>
<script type="text/javascript">
//<![CDATA[
var HTTP_STATUS_OK = 200;
var URL_API_GITHUB_RENDER_MARKDOWN = "https://api.github.com/markdown/raw";
var README_FILE_NAME = "README.md";
var repo = location.search.substring(1);
// Get Markdown, then render it as HTML
function getThenRenderMarkdown() {
var xhr = new XMLHttpRequest();
xhr.open("GET", repo + "/" + README_FILE_NAME, true);
xhr.responseType = "text";
xhr.onload = function(e) {
if (this.status == HTTP_STATUS_OK) {
// Response text contains Markdown
renderMarkdown(this.responseText);
}
}
xhr.send();
}
// Use the GitHub API to render Markdown as HTML
function renderMarkdown(markdown) {
var xhr = new XMLHttpRequest();
xhr.open("POST", URL_API_GITHUB_RENDER_MARKDOWN, true);
xhr.responseType = "html";
xhr.onload = function(e) {
if (this.status == HTTP_STATUS_OK) {
document.getElementById("readme-content").innerHTML = this.response;
}
}
xhr.send(markdown);
}
window.onload = getThenRenderMarkdown;
//]]>
</script>
</head>
<body>
<!-- The following HTML structure was copied from live GitHub page on 2015-12-01,
except for the "readme-content" id of the article element,
which was coined for this preview page.-->
<div class="main-content" role="main">
<div class="container repo-container new-discussion-timeline experiment-repo-nav">
<div class="repository-content">
<div id="readme" class="boxed-group flush clearfix announce instapaper_body md">
<h3><span class="octicon octicon-book"></span>README.md</h3>
<article class="markdown-body entry-content"
itemprop="mainContentOfPage"
id="readme-content"><p>Rendering markdown...</p></article>
</div>
</div>
</div>
</div>
</body>
</html>
