mirror of
https://github.com/litruv/Docs-Viewer.git
synced 2026-07-24 02:36:07 +10:00
added docs builder
This commit is contained in:
168
build-docs..js
Normal file
168
build-docs..js
Normal file
@@ -0,0 +1,168 @@
|
||||
//get all *.md files in ./docs, reccursively, and store them in an array, with their properties in the first block, they're from obsidian
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
|
||||
function parseFrontMatter(content) {
|
||||
const lines = content.trim().split('\n');
|
||||
let metadata = {};
|
||||
let contentStart = 0;
|
||||
|
||||
if (lines[0].trim() === '---') {
|
||||
let endMetadata = lines.findIndex((line, index) => index > 0 && line.trim() === '---');
|
||||
if (endMetadata !== -1) {
|
||||
metadata = Object.fromEntries(
|
||||
lines.slice(1, endMetadata)
|
||||
.map(line => line.match(/^([\w-]+):\s*(.*)$/))
|
||||
.filter(Boolean)
|
||||
.map(([, key, value]) => [key, value.trim()])
|
||||
);
|
||||
contentStart = endMetadata + 1;
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
metadata,
|
||||
content: lines.slice(contentStart).join('\n').trim()
|
||||
};
|
||||
}
|
||||
|
||||
function sanitizeTitle(str) {
|
||||
return str
|
||||
.toLowerCase()
|
||||
.replace(/[^\w\s-]/g, '')
|
||||
.replace(/\s+/g, '-');
|
||||
}
|
||||
|
||||
function parseFolderDoc(folder, folderName) {
|
||||
const folderDocPath = path.join(folder, folderName + '.md');
|
||||
let folderMetadata = {};
|
||||
let folderPathRel = null;
|
||||
|
||||
if (fs.existsSync(folderDocPath)) {
|
||||
const folderDocContent = fs.readFileSync(folderDocPath, 'utf-8');
|
||||
const { metadata } = parseFrontMatter(folderDocContent);
|
||||
if (!metadata.slug) {
|
||||
metadata.slug = metadata.title
|
||||
? sanitizeTitle(metadata.title)
|
||||
: sanitizeTitle(folderName);
|
||||
}
|
||||
folderPathRel = path.relative(__dirname, folderDocPath).replace(/\\/g, '/');
|
||||
folderMetadata = { ...metadata };
|
||||
}
|
||||
return { folderPathRel, folderMetadata };
|
||||
}
|
||||
|
||||
function parseMdFile(fullPath) {
|
||||
const content = fs.readFileSync(fullPath, 'utf-8');
|
||||
const { metadata } = parseFrontMatter(content);
|
||||
if (!metadata.slug) {
|
||||
metadata.slug = metadata.title
|
||||
? sanitizeTitle(metadata.title)
|
||||
: sanitizeTitle(path.parse(fullPath).name);
|
||||
}
|
||||
let result = {
|
||||
...metadata,
|
||||
title: metadata.title || path.parse(fullPath).name,
|
||||
slug: metadata.slug
|
||||
};
|
||||
|
||||
const parsedPath = path.relative(__dirname, fullPath).replace(/\\/g, '/');
|
||||
if (parsedPath) {
|
||||
result.path = parsedPath;
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
function processFolder(folder, parentSlug = '') {
|
||||
const folderName = path.parse(folder).name;
|
||||
const { folderPathRel, folderMetadata } = parseFolderDoc(folder, folderName);
|
||||
|
||||
let folderSlug = folderMetadata.slug || sanitizeTitle(folderName);
|
||||
if (folderName.toLowerCase() === 'docs' && !parentSlug) {
|
||||
folderSlug = '';
|
||||
} else if (parentSlug) {
|
||||
folderSlug = parentSlug + '/' + folderSlug;
|
||||
}
|
||||
|
||||
const items = [];
|
||||
fs.readdirSync(folder).forEach(item => {
|
||||
const fullPath = path.join(folder, item);
|
||||
const stat = fs.statSync(fullPath);
|
||||
if (stat.isDirectory() && !item.startsWith('.') && item !== 'images') {
|
||||
items.push(processFolder(fullPath, folderSlug));
|
||||
} else if (path.extname(item) === '.md' &&
|
||||
fullPath !== folderPathRel?.replace(/\//g, path.sep) &&
|
||||
path.parse(item).name.toLowerCase() !== folderName.toLowerCase()) {
|
||||
const file = parseMdFile(fullPath);
|
||||
file.slug = folderSlug ? `${folderSlug}/${file.slug}` : file.slug;
|
||||
items.push(file);
|
||||
}
|
||||
});
|
||||
|
||||
let result = {
|
||||
...folderMetadata,
|
||||
title: folderMetadata.title || folderName,
|
||||
type: 'folder',
|
||||
slug: folderSlug,
|
||||
items
|
||||
};
|
||||
|
||||
if (folderPathRel) {
|
||||
result.path = folderPathRel;
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
function readAllMarkdownFiles(dir) {
|
||||
const root = processFolder(dir);
|
||||
return root.items;
|
||||
}
|
||||
|
||||
function loadIndexTemplate() {
|
||||
const indexPath = path.join(__dirname, 'index.json');
|
||||
try {
|
||||
const indexData = JSON.parse(fs.readFileSync(indexPath, 'utf-8'));
|
||||
// Strip out documents array, keeping all other properties
|
||||
delete indexData.documents;
|
||||
return indexData;
|
||||
} catch (error) {
|
||||
console.error('Error reading index.json:', error);
|
||||
return {
|
||||
defaultPage: "welcome",
|
||||
metadata: {
|
||||
title: "Documentation",
|
||||
description: "Documentation",
|
||||
thumbnail: "img/og-image.png",
|
||||
site_name: "Documentation"
|
||||
},
|
||||
author: {}
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
function writeIndexFile(indexData) {
|
||||
const indexPath = path.join(__dirname, 'index.json');
|
||||
try {
|
||||
fs.writeFileSync(indexPath, JSON.stringify(indexData, null, 2), 'utf-8');
|
||||
console.log('Successfully wrote index.json');
|
||||
} catch (error) {
|
||||
console.error('Error writing index.json:', error);
|
||||
}
|
||||
}
|
||||
|
||||
function combineIndexes(dir) {
|
||||
const indexData = loadIndexTemplate();
|
||||
const documents = readAllMarkdownFiles(dir);
|
||||
|
||||
// Add the documents array with new content
|
||||
indexData.documents = documents;
|
||||
writeIndexFile(indexData);
|
||||
}
|
||||
|
||||
// Replace console.log with combineIndexes call
|
||||
combineIndexes(path.join(__dirname, 'docs'));
|
||||
|
||||
module.exports = readAllMarkdownFiles;
|
||||
|
||||
2
index.js
2
index.js
@@ -459,7 +459,7 @@ class DocumentService {
|
||||
|
||||
processImages(content, basePath) {
|
||||
return content.replace(/!\[\[(.*?)\]\]/g, (match, filename) => {
|
||||
const mediaPath = `${basePath}/images/${filename}`;
|
||||
const mediaPath = `./docs/images/${filename}`;
|
||||
|
||||
if (filename.toLowerCase().endsWith('.mp4')) {
|
||||
return `\n<video controls width="100%">
|
||||
|
||||
Reference in New Issue
Block a user