Я використовую локально розміщений HTML-файл для перегляду readme 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-файл використовує API GitHub для відображення відмітки у файлі 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 на задньому рівні
- Для стиснення я пропустив код обробки помилок (ви мені вірите ?!)
- Я вітаю поради щодо програмування JavaScript
Ідеї
- Я розглядаю можливість створити сховище GitHub для цього файлу HTML і розмістити файл у відділенні gh-pages, щоб GitHub слугував ним як "звичайна" веб-сторінка. Я налаштувати файл, щоб прийняти повну URL-адресу - README (або будь-який інший файл Markdown) - як рядок запиту. Мені цікаво дізнатись, чи буде розміщений GitHub розмір кроку на обмеження запиту API GitHub, і чи виявлятиму я проблеми з міждоменними (використовуючи запит Ajax, щоб отримати відмітку з іншого домену, ніж домен, що обслуговує сторінку HTML) .
Оригінальна версія (застаріла)
Я зберегла цей запис оригінальної версії за цінністю цікавості. У цій версії були такі проблеми, які вирішені в поточній версії:
- Потрібно було завантажити деякі пов'язані файли
- Він не підтримує потрапляння в той самий каталог, що і README.md
- Її HTML був більш крихким; більш чутливі до змін у GitHub
Каталог github містить HTML-файл "попередній перегляд" та пов'язані з ним файли:
.../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>
