Notes/src/build_docs_website.js

144 lines
4.1 KiB
JavaScript
Raw Normal View History

2023-01-12 16:37:30 +01:00
const fs = require("fs-extra");
const utils = require("./services/utils.js");
const html = require("html");
const USER_GUIDE_DIR = './docs/user_guide';
const META_PATH = USER_GUIDE_DIR + '/!!!meta.json';
const WEB_TMP_DIR = './tmp/user_guide_web';
fs.copySync(USER_GUIDE_DIR, WEB_TMP_DIR);
const meta = JSON.parse(fs.readFileSync(META_PATH).toString());
const rootNoteMeta = meta.files[0];
const noteIdToMeta = {};
createNoteIdToMetaMapping(rootNoteMeta);
addNavigationAndStyle(rootNoteMeta, WEB_TMP_DIR);
fs.writeFileSync(WEB_TMP_DIR + '/style.css', getCss());
function getCss() {
2023-01-13 23:54:47 +01:00
return `
body {
display: flex;
flex-direction: row-reverse;
width: 1000px;
margin: auto;
}
.note-tree-nav {
width: 200px;
margin-right: 20px;
overflow-x: auto;
}
.note-tree-nav ul {
padding-left: 20px;
}
.content {
width: 780px;
}`;
2023-01-12 16:37:30 +01:00
}
function addNavigationAndStyle(noteMeta, parentDirPath) {
const nav = createNavigation(rootNoteMeta, noteMeta);
if (noteMeta.dataFileName) {
const filePath = parentDirPath + "/" + noteMeta.dataFileName;
console.log(`Adding nav to ${filePath}`);
const content = fs.readFileSync(filePath).toString();
const depth = noteMeta.notePath.length - 1;
const updatedContent = content
.replaceAll("</head>", `<link rel="stylesheet" href="${"../".repeat(depth)}styles.css">`)
.replaceAll("</body>", nav + "</body>");
const prettified = html.prettyPrint(updatedContent, {indent_size: 2});
fs.writeFileSync(filePath, prettified);
}
for (const childNoteMeta of noteMeta.children || []) {
addNavigationAndStyle(childNoteMeta, parentDirPath + '/' + noteMeta.dirFileName);
}
}
function createNavigation(rootMeta, sourceMeta) {
function saveNavigationInner(meta) {
let html = '<li>';
const escapedTitle = utils.escapeHtml(`${meta.prefix ? `${meta.prefix} - ` : ''}${meta.title}`);
if (meta.dataFileName) {
const targetUrl = getTargetUrl(meta.noteId, sourceMeta);
html += `<a href="${targetUrl}">${escapedTitle}</a>`;
}
else {
html += escapedTitle;
}
if (meta.children && meta.children.length > 0) {
html += '<ul>';
for (const child of meta.children) {
html += saveNavigationInner(child);
}
html += '</ul>'
}
return `${html}</li>`;
}
return `<nav class="note-tree-nav"><ul>${saveNavigationInner(rootMeta)}</ul></nav>`;
}
function createNoteIdToMetaMapping(noteMeta) {
noteIdToMeta[noteMeta.noteId] = noteMeta;
for (const childNoteMeta of noteMeta.children || []) {
createNoteIdToMetaMapping(childNoteMeta);
}
}
function getTargetUrl(targetNoteId, sourceMeta) {
const targetMeta = noteIdToMeta[targetNoteId];
if (!targetMeta) {
throw new Error(`Could not find note meta for noteId '${targetNoteId}'`);
}
const targetPath = targetMeta.notePath.slice();
const sourcePath = sourceMeta.notePath.slice();
// > 1 for edge case that targetPath and sourcePath are exact same (link to itself)
while (targetPath.length > 1 && sourcePath.length > 1 && targetPath[0] === sourcePath[0]) {
targetPath.shift();
sourcePath.shift();
}
let url = "../".repeat(sourcePath.length - 1);
for (let i = 0; i < targetPath.length - 1; i++) {
const meta = noteIdToMeta[targetPath[i]];
if (!meta) {
throw new Error(`Cannot resolve note '${targetPath[i]}' from path '${targetPath.toString()}'`);
}
url += `${encodeURIComponent(meta.dirFileName)}/`;
}
const targetPathNoteId = targetPath[targetPath.length - 1];
const meta = noteIdToMeta[targetPathNoteId];
if (!meta) {
throw new Error(`Cannot resolve note '${targetPathNoteId}' from path '${targetPath.toString()}'`);
}
// link can target note which is only "folder-note" and as such will not have a file in an export
url += encodeURIComponent(meta.dataFileName || meta.dirFileName);
return url;
}