Я использую локально размещенный HTML-файл для предварительного просмотра файлов GitHub.
Я просмотрел несколько существующих вариантов, но решил свернуть свой, чтобы выполнить следующие требования:
- Отдельный файл
- Локально размещенный (интранет) URL
- Расширение браузера не требуется
- Нет локальной обработки на стороне сервера (например, без PHP)
- Легкий вес (например, нет JQuery)
- Высокая точность: используйте GitHub для визуализации Markdown и тот же CSS
Я храню локальные копии своих репозиториев GitHub в одноуровневых каталогах в каталоге "github".
Каждый каталог репо содержит файл README.md:
.../github/
repo-a/
README.md
repo-b/
README.md
etc.
Каталог github содержит HTML-файл предварительного просмотра:
.../github/
readme.html
Для предварительного просмотра файла readme я просматриваю github / readme.html, указывая репо в строке запроса:
http://localhost/github/readme.html?repo-a
Кроме того, вы можете скопировать readme.html в тот же каталог, что и README.md, и опустить строку запроса:
http://localhost/github/repo-a/readme.html
Если файл readme.html находится в том же каталоге, что и README.md, вам даже не нужно обслуживать файл readme.html через HTTP: вы можете просто открыть его прямо из своей файловой системы.
HTML-файл использует GitHub API для визуализации Markdown в файле README.md. Существует ограничение скорости : на момент написания 60 запросов в час .
Работает для меня в текущих производственных версиях Chrome, IE и Firefox на Windows 7.
Источник
Вот 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>
Примечания разработчика
- Как правило, я оборачиваю свой код в IIFE, но в этом случае я не видел необходимости и думал, что буду держать его сжатым
- Я не удосужился поддержать IE уровня backlevel
- Для краткости я пропустил код обработки ошибок (вы мне верите ?!)
- Я бы приветствовал советы по программированию JavaScript
идеи
- Я подумываю создать GitHub-репозиторий для этого HTML-файла и поместить его в ветку gh-pages, чтобы GitHub использовал его как «обычную» веб-страницу. Я бы настроил файл, чтобы принять полный URL - README (или любой другой файл Markdown) - в качестве строки запроса. Мне любопытно посмотреть, обойдется ли размещение на GitHub в обход ограничения на запросы API GitHub, и столкнулся ли я с междоменными проблемами (используя запрос Ajax для получения Markdown из другого домена, чем домен, обслуживающий страницу HTML) ,
Оригинальная версия (устарела)
Я сохранил эту запись оригинальной версии для любопытства. В этой версии были следующие проблемы, которые решаются в текущей версии:
- Требуется загрузка некоторых связанных файлов
- Он не поддерживает удаление в тот же каталог, что и README.md
- Его HTML был более хрупким; более подвержен изменениям в GitHub
Каталог github содержит HTML-файл «preview» и связанные файлы:
.../github/
readme-preview.html
github.css
github2.css
octicons.eot
octicons.svg
octicons.woff
Я скачал файлы шрифтов CSS и octicons с 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)
Я переименовал файлы CSS, чтобы опустить длинную строку шестнадцатеричных цифр в исходных именах.
Я отредактировал github.css для ссылки на локальные копии файлов шрифтов octicons.
Я изучил HTML-код страницы GitHub и воспроизвел достаточно структуры HTML, окружающей содержимое readme, чтобы обеспечить разумную точность; например, ограниченная ширина.
CSS GitHub, шрифт octicons и HTML-контейнер для содержимого readme являются движущимися целями: мне нужно будет периодически загружать новые версии.
Я играл с использованием CSS из различных проектов GitHub. Например:
<link rel="stylesheet" type="text/css"
href="http://rawgit.com/sindresorhus/github-markdown-css/gh-pages/github-markdown.css">
но в итоге решил использовать CSS от самого GitHub.
Источник
Вот 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>
