docs: use dockhand for static generation

Drop Gatsby, use a simplified custom static site generator that uses GFM
and a template for extremely lightweight docs.

Author: ethomson

.gitignore

@@ -7,8 +7,7 @@ npm-debug.log
 /test/packages/test-package/random-data.txt
 /test/root
 /node_modules/.bin
-/docs/public/
-/docs/.cache/
+/docs/output/
 /docs/node_modules/
 /man/
 /npmrc

Makefile

@@ -49,8 +49,7 @@ mandocs: $(mandocs)
 
 htmldocs:
 	cd docs && node ../bin/npm-cli.js install --legacy-peer-deps --no-audit && \
-	node ../bin/npm-cli.js run build:static >&2 && \
-	rm -rf node_modules .cache public/*js public/*json public/404* public/page-data public/manifest*
+	node ../bin/npm-cli.js run build >&2
 
 docs: mandocs htmldocs
 
@@ -67,7 +66,7 @@ docs-clean:
     .building_marked-man \
     man \
     docs/node_modules \
-    docs/public \
+    docs/output \
     docs/.cache
 
 ## build-time tools for the documentation

docs/LICENSE

@@ -0,0 +1,5 @@
+{
+    "github_repo": "npm/cli",
+    "github_branch": "latest",
+    "github_path": "docs/content"
+}

docs/config.json

@@ -0,0 +1,140 @@
+#!/usr/bin/env node
+
+const path = require('path');
+const fs = require('fs');
+const yaml = require('yaml');
+const cmark = require('cmark-gfm');
+const mkdirp = require('mkdirp');
+const jsdom = require('jsdom');
+const npm = require('../lib/npm.js')
+
+const config = require('./config.json');
+
+const docsRoot = __dirname;
+const inputRoot = path.join(docsRoot, 'content');
+const outputRoot = path.join(docsRoot, 'output');
+
+const template = fs.readFileSync('template.html').toString();
+
+walk(inputRoot);
+
+function walk(root, dirRelative) {
+    const dirPath = dirRelative ? path.join(root, dirRelative) : root;
+
+    fs.readdirSync(dirPath).forEach((childFilename) => {
+        const childRelative = dirRelative ? path.join(dirRelative, childFilename) : childFilename;
+        const childPath = path.join(root, childRelative);
+
+        if (fs.lstatSync(childPath).isDirectory()) {
+            walk(root, childRelative);
+        }
+        else {
+            translate(childRelative);
+        }
+    });
+}
+
+function translate(childPath) {
+    const inputPath = path.join(inputRoot, childPath);
+
+    if (!inputPath.match(/\.md$/)) {
+        console.log(`warning: unknown file type ${inputPath}, ignored`);
+        return;
+    }
+
+    const outputPath = path.join(outputRoot, childPath.replace(/\.md$/, '.html'));
+
+    let md = fs.readFileSync(inputPath).toString();
+    let frontmatter = { };
+
+    // Take the leading frontmatter out of the markdown
+    md = md.replace(/^---\n([\s\S]+)\n---\n/, (header, fm) => {
+        frontmatter = yaml.parse(fm, 'utf8');
+        return '';
+    });
+
+    // Replace any tokens in the source
+    md = md.replace(/@VERSION@/, npm.version);
+
+    // Render the markdown into an HTML snippet using a GFM renderer.
+    const content = cmark.renderHtmlSync(md, {
+        'smart': true,
+        'githubPreLang': true,
+        'strikethroughDoubleTilde': true,
+        'unsafe': false,
+        extensions: {
+            'table': true,
+            'strikethrough': true,
+            'tagfilter': true,
+            'autolink': true
+        }
+    });
+
+    // Inject this data into the template, using a mustache-like
+    // replacement scheme.
+    const html = template.replace(/\{\{\s*([\w\.]+)\s*\}\}/g, (token, key) => {
+        switch (key) {
+            case 'content':
+                return content;
+            case 'path':
+                return childPath;
+            case 'url_path':
+                return encodeURI(childPath);
+
+            case 'title':
+            case 'section':
+            case 'description':
+                return frontmatter[key];
+
+            case 'config.github_repo':
+            case 'config.github_branch':
+            case 'config.github_path':
+                return config[key.replace(/^config\./, '')];
+
+            default:
+                console.log(`warning: unknown token '${token}' in ${inputPath}`);
+                return '';
+        }
+        console.log(key);
+        return key;
+    });
+
+    const dom = new jsdom.JSDOM(html);
+    const document = dom.window.document;
+
+    // Rewrite relative URLs in links and image sources to be relative to
+    // this file; this is for supporting `file://` links.  HTML pages need
+    // suffix appended.
+    const links = [
+        { tag: 'a', attr: 'href', suffix: '.html' },
+        { tag: 'img', attr: 'src' }
+    ];
+
+    for (let linktype of links) {
+        for (let tag of document.querySelectorAll(linktype.tag)) {
+            let url = tag.getAttribute(linktype.attr);
+
+            if (url.startsWith('/')) {
+                const childDepth = childPath.split('/').length - 1;
+                const prefix = childDepth > 0 ? '../'.repeat(childDepth) : './';
+
+                url = url.replace(/^\//, prefix);
+
+                if (linktype.suffix) {
+                    url += linktype.suffix;
+                }
+
+                tag.setAttribute(linktype.attr, url);
+            }
+        }
+    }
+
+    const output = dom.serialize();
+
+    mkdirp.sync(path.dirname(outputPath));
+    fs.writeFileSync(outputPath, output);
+}
+
+function debug(str) {
+    console.log(str);
+}