Dockery/Trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-10-31 02:16:05 +01:00
Code Issues Packages Projects Releases Activity

feat(edit-docs): generate HTML documentation as well

Browse Source
This commit is contained in:
Elian Doran
2025-03-11 21:58:32 +02:00
parent 9d161a007e
commit 5ee13623ee
1 changed files with 12 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
electron-docs-main.ts
View File

@@ -10,7 +10,8 @@ import type { WriteStream } from "fs";
import debounce from "./src/public/app/services/debounce.js"; import debounce from "./src/public/app/services/debounce.js";
const NOTE_ID_USER_GUIDE = "pOsGYCXsbNQG"; const NOTE_ID_USER_GUIDE = "pOsGYCXsbNQG";
const destRootPath = path.join("docs", "User Guide"); const markdownPath = path.join("docs", "User Guide");
const htmlPath = path.join("src", "public", "app", "doc_notes", "en", "User Guide");
async function startElectron() { async function startElectron() {
await import("./electron-main.js"); await import("./electron-main.js");
@@ -83,7 +84,7 @@ async function createImportZip() {
zlib: { level: 0 } zlib: { level: 0 }
}); });
archive.directory(destRootPath, "/"); archive.directory(markdownPath, "/");
const outputStream = fsExtra.createWriteStream(inputFile); const outputStream = fsExtra.createWriteStream(inputFile);
archive.pipe(outputStream); archive.pipe(outputStream);
@@ -104,18 +105,18 @@ function waitForEnd(archive: Archiver, stream: WriteStream) {
} }
async function exportData() { async function exportData(format: "html" | "markdown", outputPath: string) {
const zipFilePath = "output.zip"; const zipFilePath = "output.zip";
const deferred = (await import("./src/services/utils.js")).deferred; const deferred = (await import("./src/services/utils.js")).deferred;
try { try {
await fsExtra.remove(destRootPath); await fsExtra.remove(outputPath);
await fsExtra.mkdir(destRootPath); await fsExtra.mkdir(outputPath);
// First export as zip. // First export as zip.
const { exportToZipFile } = (await import("./src/services/export/zip.js")).default; const { exportToZipFile } = (await import("./src/services/export/zip.js")).default;
await exportToZipFile(NOTE_ID_USER_GUIDE, "markdown", zipFilePath); await exportToZipFile(NOTE_ID_USER_GUIDE, format, zipFilePath);
const promise = deferred<void>() const promise = deferred<void>()
setTimeout(async () => { setTimeout(async () => {
@@ -124,7 +125,7 @@ async function exportData() {
await readZipFile(await fs.readFile(zipFilePath), async (zip, entry) => { await readZipFile(await fs.readFile(zipFilePath), async (zip, entry) => {
// We ignore directories since they can appear out of order anyway. // We ignore directories since they can appear out of order anyway.
if (!entry.fileName.endsWith("/")) { if (!entry.fileName.endsWith("/")) {
const destPath = path.join(destRootPath, entry.fileName); const destPath = path.join(outputPath, entry.fileName);
const fileContent = await readContent(zip, entry); const fileContent = await readContent(zip, entry);
await fsExtra.mkdirs(path.dirname(destPath)); await fsExtra.mkdirs(path.dirname(destPath));
@@ -146,7 +147,7 @@ async function exportData() {
} }
async function cleanUpMeta() { async function cleanUpMeta() {
const metaPath = path.join(destRootPath, "!!!meta.json"); const metaPath = path.join(markdownPath, "!!!meta.json");
const meta = JSON.parse(await fs.readFile(metaPath, "utf-8")) as NoteMetaFile; const meta = JSON.parse(await fs.readFile(metaPath, "utf-8")) as NoteMetaFile;
for (const file of meta.files) { for (const file of meta.files) {
traverse(file); traverse(file);
@@ -165,9 +166,10 @@ async function cleanUpMeta() {
async function registerHandlers() { async function registerHandlers() {
const events = (await import("./src/services/events.js")).default; const events = (await import("./src/services/events.js")).default;
const debouncer = debounce(() => { const debouncer = debounce(async () => {
console.log("Exporting data"); console.log("Exporting data");
exportData(); await exportData("markdown", markdownPath);
await exportData("html", htmlPath);
}, 10_000);; }, 10_000);;
events.subscribe(events.ENTITY_CHANGED, async (e) => { events.subscribe(events.ENTITY_CHANGED, async (e) => {
if (e.entityName === "options") { if (e.entityName === "options") {