Add plain-language concept docs; fix docs viewer rendering; link API tokens
- New docs/concepts-{hosts,dns,access,api-tokens}.md -- plain-language
guides aimed at less technical readers, each linking onward to the
existing system-design-level doc for anyone who wants that detail.
Card help links (Proxy List, Add/Edit host, DNS Provider cards,
Users/Permissions/Groups cards) now point here instead of straight at
Installation/Architecture.
- The "New API Token" card had no help link at all -- added, pointing to
the new API Tokens doc.
- Fixed the in-app docs viewer rendering every docs/*.md page with a
garbled heading + stray <hr> at the top: Jekyll front matter (meant
only for the GitHub Pages build) was never stripped before being
handed to the markdown renderer.
- Fixed cross-doc links never resolving in-app, since this viewer serves
docs at /docs/<slug> with no .html suffix: rewritten to the correct
in-app URL, first by registered slug, falling back to the doc's real
filename (the correct, working link form on the Jekyll/GitHub Pages
build) -- same idea as the existing image-path fix, and lets one link
written in a doc work on both targets.
Bumps to v1.1.13.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KDEx8ghuZR61pqPXc6da9C
This commit is contained in:
+48
-3
@@ -33,6 +33,15 @@ const values = {
|
||||
// An explicit slug -> file allowlist, never a user-suppliable path, so
|
||||
// there's no way to make this read outside the doc set below.
|
||||
const DOCS = {
|
||||
// Plain-language "what is this and why would I use it" guides -- linked
|
||||
// directly from the relevant card in the UI (see the help icon on each
|
||||
// card). Each links onward to the deeper technical doc below for readers
|
||||
// who want the system-design/protocol-level detail.
|
||||
hosts: {title: 'Hosts & HTTPS', file: path.join(__dirname, '../../docs/concepts-hosts.md')},
|
||||
dns: {title: 'DNS Providers', file: path.join(__dirname, '../../docs/concepts-dns.md')},
|
||||
access: {title: 'Users, Groups & Permissions', file: path.join(__dirname, '../../docs/concepts-access.md')},
|
||||
'api-tokens': {title: 'API Tokens', file: path.join(__dirname, '../../docs/concepts-api-tokens.md')},
|
||||
|
||||
overview: {title: 'Overview', file: path.join(__dirname, '../../README.md')},
|
||||
changelog: {title: 'Changelog', file: path.join(__dirname, '../../CHANGELOG.md')},
|
||||
deployment: {title: 'Deployment', file: path.join(__dirname, '../../DEPLOYMENT.md')},
|
||||
@@ -54,6 +63,42 @@ function fixImagePaths(html) {
|
||||
return html.replace(/(["(])docs\/images\//g, '$1/docs/images/');
|
||||
}
|
||||
|
||||
// docs/*.md files (not the repo-root README/CHANGELOG/api.md) carry Jekyll
|
||||
// front matter for the GitHub Pages build and a "← Back to Home" link back
|
||||
// to that site's index -- both meaningless here (this viewer has its own
|
||||
// doc-list sidebar, docs_page.ejs) and, worse, marked() doesn't know front
|
||||
// matter isn't regular markdown: it rendered as a garbled heading + stray
|
||||
// <hr> at the top of every page. Strip both before rendering.
|
||||
function stripJekyllCruft(content) {
|
||||
return content
|
||||
.replace(/^---\n[\s\S]*?\n---\n/, '')
|
||||
.replace(/^\s*\[← Back to Home\]\([^)]*\)\s*\n/m, '');
|
||||
}
|
||||
|
||||
// Docs cross-link each other as "<slug>.html" (correct for the Jekyll/GitHub
|
||||
// Pages build, which is what these same .md files also feed) and
|
||||
// "index.html" for the docs home -- neither resolves here, where a doc lives
|
||||
// at /docs/<slug> with no .html suffix. Rewrite known doc links to the
|
||||
// in-app route, same idea as fixImagePaths() above. Only touches slugs that
|
||||
// actually exist, so an unrelated "foo.html" link is left alone.
|
||||
// Docs are also linked by their real filename stem (e.g. "concepts-hosts.html"
|
||||
// for docs/concepts-hosts.md) -- the correct, working link on the Jekyll/
|
||||
// GitHub Pages build, where the URL IS the filename stem. That doesn't match
|
||||
// this viewer's own short slugs (DOCS keys, e.g. "hosts"), so also resolve by
|
||||
// filename as a fallback -- one link written in a doc works correctly on
|
||||
// both targets, rather than needing two different link forms.
|
||||
const slugByFilename = Object.fromEntries(
|
||||
Object.entries(DOCS).map(([slug, d]) => [path.basename(d.file, '.md'), slug])
|
||||
);
|
||||
function fixDocLinks(html) {
|
||||
return html
|
||||
.replace(/href="index\.html"/g, 'href="/docs"')
|
||||
.replace(/href="([a-z0-9-]+)\.html"/g, (match, name) => {
|
||||
const slug = DOCS[name] ? name : slugByFilename[name];
|
||||
return slug ? `href="/docs/${slug}"` : match;
|
||||
});
|
||||
}
|
||||
|
||||
router.use(docsLimiter);
|
||||
|
||||
router.get('/', function(req, res) {
|
||||
@@ -73,7 +118,7 @@ router.get('/search', function(req, res) {
|
||||
const results = [];
|
||||
for (const [slug, doc] of Object.entries(DOCS)) {
|
||||
try {
|
||||
const content = fs.readFileSync(doc.file, 'utf8');
|
||||
const content = stripJekyllCruft(fs.readFileSync(doc.file, 'utf8'));
|
||||
const matchLine = content.split('\n').find(line => line.toLowerCase().includes(qLower));
|
||||
if (matchLine) {
|
||||
results.push({slug, title: doc.title, snippet: matchLine.trim().slice(0, 200)});
|
||||
@@ -89,13 +134,13 @@ router.get('/:slug', function(req, res, next) {
|
||||
if (!doc) return next({status: 404, message: 'Doc not found'});
|
||||
|
||||
try {
|
||||
const content = fs.readFileSync(doc.file, 'utf8');
|
||||
const content = stripJekyllCruft(fs.readFileSync(doc.file, 'utf8'));
|
||||
res.render('docs_page', {
|
||||
...values,
|
||||
docs: docList,
|
||||
currentSlug: req.params.slug,
|
||||
docTitle: doc.title,
|
||||
docHtml: fixImagePaths(marked(content)),
|
||||
docHtml: fixDocLinks(fixImagePaths(marked(content))),
|
||||
});
|
||||
} catch (error) {
|
||||
next(error);
|
||||
|
||||
Reference in New Issue
Block a user