living-documentation 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +178 -0
- package/dist/bin/cli.d.ts +3 -0
- package/dist/bin/cli.d.ts.map +1 -0
- package/dist/bin/cli.js +38 -0
- package/dist/bin/cli.js.map +1 -0
- package/dist/src/frontend/admin.html +268 -0
- package/dist/src/frontend/index.html +508 -0
- package/dist/src/lib/config.d.ts +11 -0
- package/dist/src/lib/config.d.ts.map +1 -0
- package/dist/src/lib/config.js +43 -0
- package/dist/src/lib/config.js.map +1 -0
- package/dist/src/lib/parser.d.ts +10 -0
- package/dist/src/lib/parser.d.ts.map +1 -0
- package/dist/src/lib/parser.js +63 -0
- package/dist/src/lib/parser.js.map +1 -0
- package/dist/src/routes/config.d.ts +3 -0
- package/dist/src/routes/config.d.ts.map +1 -0
- package/dist/src/routes/config.js +42 -0
- package/dist/src/routes/config.js.map +1 -0
- package/dist/src/routes/documents.d.ts +3 -0
- package/dist/src/routes/documents.d.ts.map +1 -0
- package/dist/src/routes/documents.js +106 -0
- package/dist/src/routes/documents.js.map +1 -0
- package/dist/src/server.d.ts +7 -0
- package/dist/src/server.d.ts.map +1 -0
- package/dist/src/server.js +54 -0
- package/dist/src/server.js.map +1 -0
- package/package.json +41 -0
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.configRouter = configRouter;
|
|
4
|
+
const express_1 = require("express");
|
|
5
|
+
const config_1 = require("../lib/config");
|
|
6
|
+
function configRouter(docsPath) {
|
|
7
|
+
const router = (0, express_1.Router)();
|
|
8
|
+
// GET /api/config
|
|
9
|
+
router.get('/', (_req, res) => {
|
|
10
|
+
try {
|
|
11
|
+
res.json((0, config_1.readConfig)(docsPath));
|
|
12
|
+
}
|
|
13
|
+
catch {
|
|
14
|
+
res.status(500).json({ error: 'Failed to read config' });
|
|
15
|
+
}
|
|
16
|
+
});
|
|
17
|
+
// PUT /api/config
|
|
18
|
+
router.put('/', (req, res) => {
|
|
19
|
+
try {
|
|
20
|
+
const patch = req.body;
|
|
21
|
+
// Only allow safe fields — prevent path traversal via config
|
|
22
|
+
const allowed = [
|
|
23
|
+
'title',
|
|
24
|
+
'filenamePattern',
|
|
25
|
+
'theme',
|
|
26
|
+
];
|
|
27
|
+
const safe = {};
|
|
28
|
+
for (const key of allowed) {
|
|
29
|
+
if (key in patch) {
|
|
30
|
+
safe[key] = patch[key];
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
const updated = (0, config_1.writeConfig)(docsPath, safe);
|
|
34
|
+
res.json(updated);
|
|
35
|
+
}
|
|
36
|
+
catch {
|
|
37
|
+
res.status(500).json({ error: 'Failed to update config' });
|
|
38
|
+
}
|
|
39
|
+
});
|
|
40
|
+
return router;
|
|
41
|
+
}
|
|
42
|
+
//# sourceMappingURL=config.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/routes/config.ts"],"names":[],"mappings":";;AAGA,oCAoCC;AAvCD,qCAAoD;AACpD,0CAAyE;AAEzE,SAAgB,YAAY,CAAC,QAAgB;IAC3C,MAAM,MAAM,GAAG,IAAA,gBAAM,GAAE,CAAC;IAExB,kBAAkB;IAClB,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,IAAa,EAAE,GAAa,EAAE,EAAE;QAC/C,IAAI,CAAC;YACH,GAAG,CAAC,IAAI,CAAC,IAAA,mBAAU,EAAC,QAAQ,CAAC,CAAC,CAAC;QACjC,CAAC;QAAC,MAAM,CAAC;YACP,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,uBAAuB,EAAE,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,kBAAkB;IAClB,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAY,EAAE,GAAa,EAAE,EAAE;QAC9C,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,GAAG,CAAC,IAAgC,CAAC;YACnD,6DAA6D;YAC7D,MAAM,OAAO,GAA8B;gBACzC,OAAO;gBACP,iBAAiB;gBACjB,OAAO;aACR,CAAC;YACF,MAAM,IAAI,GAA6B,EAAE,CAAC;YAC1C,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;gBAC1B,IAAI,GAAG,IAAI,KAAK,EAAE,CAAC;oBAChB,IAAgC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;gBACtD,CAAC;YACH,CAAC;YACD,MAAM,OAAO,GAAG,IAAA,oBAAW,EAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAC5C,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpB,CAAC;QAAC,MAAM,CAAC;YACP,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,yBAAyB,EAAE,CAAC,CAAC;QAC7D,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"documents.d.ts","sourceRoot":"","sources":["../../../src/routes/documents.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAqB,MAAM,SAAS,CAAC;AA8BpD,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CA6ExD"}
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.documentsRouter = documentsRouter;
|
|
7
|
+
const express_1 = require("express");
|
|
8
|
+
const fs_1 = __importDefault(require("fs"));
|
|
9
|
+
const path_1 = __importDefault(require("path"));
|
|
10
|
+
const marked_1 = require("marked");
|
|
11
|
+
const parser_1 = require("../lib/parser");
|
|
12
|
+
function listDocs(docsPath) {
|
|
13
|
+
const files = fs_1.default
|
|
14
|
+
.readdirSync(docsPath)
|
|
15
|
+
.filter((f) => f.toLowerCase().endsWith('.md'));
|
|
16
|
+
const docs = files.map((filename) => (0, parser_1.parseFilename)(filename));
|
|
17
|
+
// Sort: dated docs first (newest → oldest), then undated alphabetically
|
|
18
|
+
docs.sort((a, b) => {
|
|
19
|
+
if (a.date && b.date)
|
|
20
|
+
return b.date.localeCompare(a.date);
|
|
21
|
+
if (a.date)
|
|
22
|
+
return -1;
|
|
23
|
+
if (b.date)
|
|
24
|
+
return 1;
|
|
25
|
+
return a.title.localeCompare(b.title);
|
|
26
|
+
});
|
|
27
|
+
return docs;
|
|
28
|
+
}
|
|
29
|
+
function safeFilePath(docsPath, filename) {
|
|
30
|
+
const resolved = path_1.default.resolve(docsPath, filename);
|
|
31
|
+
if (!resolved.startsWith(path_1.default.resolve(docsPath) + path_1.default.sep))
|
|
32
|
+
return null;
|
|
33
|
+
return resolved;
|
|
34
|
+
}
|
|
35
|
+
function documentsRouter(docsPath) {
|
|
36
|
+
const router = (0, express_1.Router)();
|
|
37
|
+
// GET /api/documents — list all docs with metadata
|
|
38
|
+
router.get('/', (_req, res) => {
|
|
39
|
+
try {
|
|
40
|
+
res.json(listDocs(docsPath));
|
|
41
|
+
}
|
|
42
|
+
catch {
|
|
43
|
+
res.status(500).json({ error: 'Failed to list documents' });
|
|
44
|
+
}
|
|
45
|
+
});
|
|
46
|
+
// GET /api/documents/search?q=query — full-text search
|
|
47
|
+
router.get('/search', (req, res) => {
|
|
48
|
+
const query = (req.query.q ?? '').toLowerCase().trim();
|
|
49
|
+
if (!query)
|
|
50
|
+
return res.json([]);
|
|
51
|
+
try {
|
|
52
|
+
const docs = listDocs(docsPath);
|
|
53
|
+
const results = [];
|
|
54
|
+
for (const doc of docs) {
|
|
55
|
+
const filePath = safeFilePath(docsPath, doc.filename);
|
|
56
|
+
if (!filePath || !fs_1.default.existsSync(filePath))
|
|
57
|
+
continue;
|
|
58
|
+
const content = fs_1.default.readFileSync(filePath, 'utf-8');
|
|
59
|
+
const inTitle = doc.title.toLowerCase().includes(query);
|
|
60
|
+
const inCategory = doc.category.toLowerCase().includes(query);
|
|
61
|
+
const inContent = content.toLowerCase().includes(query);
|
|
62
|
+
if (inTitle || inCategory || inContent) {
|
|
63
|
+
// Extract a snippet around the first match in content
|
|
64
|
+
let excerpt = '';
|
|
65
|
+
if (inContent) {
|
|
66
|
+
const idx = content.toLowerCase().indexOf(query);
|
|
67
|
+
const start = Math.max(0, idx - 60);
|
|
68
|
+
const end = Math.min(content.length, idx + query.length + 90);
|
|
69
|
+
excerpt =
|
|
70
|
+
(start > 0 ? '…' : '') +
|
|
71
|
+
content.slice(start, end).replace(/\n+/g, ' ').trim() +
|
|
72
|
+
(end < content.length ? '…' : '');
|
|
73
|
+
}
|
|
74
|
+
results.push({ ...doc, excerpt });
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
res.json(results);
|
|
78
|
+
}
|
|
79
|
+
catch {
|
|
80
|
+
res.status(500).json({ error: 'Search failed' });
|
|
81
|
+
}
|
|
82
|
+
});
|
|
83
|
+
// GET /api/documents/:id — get a single document (content + rendered HTML)
|
|
84
|
+
router.get('/:id', async (req, res) => {
|
|
85
|
+
const id = decodeURIComponent(req.params.id);
|
|
86
|
+
const filename = id + '.md';
|
|
87
|
+
const filePath = safeFilePath(docsPath, filename);
|
|
88
|
+
if (!filePath) {
|
|
89
|
+
return res.status(403).json({ error: 'Access denied' });
|
|
90
|
+
}
|
|
91
|
+
if (!fs_1.default.existsSync(filePath)) {
|
|
92
|
+
return res.status(404).json({ error: 'Document not found' });
|
|
93
|
+
}
|
|
94
|
+
try {
|
|
95
|
+
const content = fs_1.default.readFileSync(filePath, 'utf-8');
|
|
96
|
+
const metadata = (0, parser_1.parseFilename)(filename);
|
|
97
|
+
const html = marked_1.marked.parse(content);
|
|
98
|
+
res.json({ ...metadata, content, html });
|
|
99
|
+
}
|
|
100
|
+
catch {
|
|
101
|
+
res.status(500).json({ error: 'Failed to read document' });
|
|
102
|
+
}
|
|
103
|
+
});
|
|
104
|
+
return router;
|
|
105
|
+
}
|
|
106
|
+
//# sourceMappingURL=documents.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"documents.js","sourceRoot":"","sources":["../../../src/routes/documents.ts"],"names":[],"mappings":";;;;;AA8BA,0CA6EC;AA3GD,qCAAoD;AACpD,4CAAoB;AACpB,gDAAwB;AACxB,mCAAgC;AAChC,0CAA2D;AAE3D,SAAS,QAAQ,CAAC,QAAgB;IAChC,MAAM,KAAK,GAAG,YAAE;SACb,WAAW,CAAC,QAAQ,CAAC;SACrB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAElD,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAA,sBAAa,EAAC,QAAQ,CAAC,CAAC,CAAC;IAE9D,wEAAwE;IACxE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACjB,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI;YAAE,OAAO,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC1D,IAAI,CAAC,CAAC,IAAI;YAAE,OAAO,CAAC,CAAC,CAAC;QACtB,IAAI,CAAC,CAAC,IAAI;YAAE,OAAO,CAAC,CAAC;QACrB,OAAO,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,YAAY,CAAC,QAAgB,EAAE,QAAgB;IACtD,MAAM,QAAQ,GAAG,cAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAClD,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,cAAI,CAAC,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC;IACzE,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAgB,eAAe,CAAC,QAAgB;IAC9C,MAAM,MAAM,GAAG,IAAA,gBAAM,GAAE,CAAC;IAExB,mDAAmD;IACnD,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,IAAa,EAAE,GAAa,EAAE,EAAE;QAC/C,IAAI,CAAC;YACH,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC/B,CAAC;QAAC,MAAM,CAAC;YACP,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,0BAA0B,EAAE,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,uDAAuD;IACvD,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,GAAY,EAAE,GAAa,EAAE,EAAE;QACpD,MAAM,KAAK,GAAG,CAAE,GAAG,CAAC,KAAK,CAAC,CAAY,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC;QACnE,IAAI,CAAC,KAAK;YAAE,OAAO,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAEhC,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;YAChC,MAAM,OAAO,GAA0C,EAAE,CAAC;YAE1D,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACvB,MAAM,QAAQ,GAAG,YAAY,CAAC,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;gBACtD,IAAI,CAAC,QAAQ,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,QAAQ,CAAC;oBAAE,SAAS;gBAEpD,MAAM,OAAO,GAAG,YAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBACnD,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBACxD,MAAM,UAAU,GAAG,GAAG,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAC9D,MAAM,SAAS,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAExD,IAAI,OAAO,IAAI,UAAU,IAAI,SAAS,EAAE,CAAC;oBACvC,sDAAsD;oBACtD,IAAI,OAAO,GAAG,EAAE,CAAC;oBACjB,IAAI,SAAS,EAAE,CAAC;wBACd,MAAM,GAAG,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;wBACjD,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,CAAC;wBACpC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,GAAG,KAAK,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;wBAC9D,OAAO;4BACL,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;gCACtB,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE;gCACrD,CAAC,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;oBACtC,CAAC;oBACD,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;gBACpC,CAAC;YACH,CAAC;YAED,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpB,CAAC;QAAC,MAAM,CAAC;YACP,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC,CAAC;QACnD,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,2EAA2E;IAC3E,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;QACvD,MAAM,EAAE,GAAG,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAG,EAAE,GAAG,KAAK,CAAC;QAC5B,MAAM,QAAQ,GAAG,YAAY,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAElD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC,CAAC;QAC1D,CAAC;QAED,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC7B,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,oBAAoB,EAAE,CAAC,CAAC;QAC/D,CAAC;QAED,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,YAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YACnD,MAAM,QAAQ,GAAG,IAAA,sBAAa,EAAC,QAAQ,CAAC,CAAC;YACzC,MAAM,IAAI,GAAG,eAAM,CAAC,KAAK,CAAC,OAAO,CAAW,CAAC;YAC7C,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QAC3C,CAAC;QAAC,MAAM,CAAC;YACP,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,yBAAyB,EAAE,CAAC,CAAC;QAC7D,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../src/server.ts"],"names":[],"mappings":"AAOA,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,wBAAsB,WAAW,CAAC,EAChC,QAAQ,EACR,IAAI,EACJ,WAAmB,GACpB,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CA2C/B"}
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.startServer = startServer;
|
|
7
|
+
const express_1 = __importDefault(require("express"));
|
|
8
|
+
const path_1 = __importDefault(require("path"));
|
|
9
|
+
const child_process_1 = require("child_process");
|
|
10
|
+
const documents_1 = require("./routes/documents");
|
|
11
|
+
const config_1 = require("./routes/config");
|
|
12
|
+
const config_2 = require("./lib/config");
|
|
13
|
+
async function startServer({ docsPath, port, openBrowser = false, }) {
|
|
14
|
+
const app = (0, express_1.default)();
|
|
15
|
+
app.use(express_1.default.json());
|
|
16
|
+
// Persist initial state to .living-doc.json
|
|
17
|
+
(0, config_2.writeConfig)(docsPath, { docsFolder: docsPath, port });
|
|
18
|
+
// API
|
|
19
|
+
app.use('/api/documents', (0, documents_1.documentsRouter)(docsPath));
|
|
20
|
+
app.use('/api/config', (0, config_1.configRouter)(docsPath));
|
|
21
|
+
// Static frontend assets
|
|
22
|
+
const frontendPath = path_1.default.join(__dirname, 'frontend');
|
|
23
|
+
app.use(express_1.default.static(frontendPath));
|
|
24
|
+
app.get('/', (_req, res) => res.sendFile(path_1.default.join(frontendPath, 'index.html')));
|
|
25
|
+
app.get('/admin', (_req, res) => res.sendFile(path_1.default.join(frontendPath, 'admin.html')));
|
|
26
|
+
return new Promise((resolve) => {
|
|
27
|
+
app.listen(port, () => {
|
|
28
|
+
const url = `http://localhost:${port}`;
|
|
29
|
+
console.log('');
|
|
30
|
+
console.log(' Living Documentation');
|
|
31
|
+
console.log(' ─────────────────────────────────');
|
|
32
|
+
console.log(` Local: ${url}`);
|
|
33
|
+
console.log(` Admin: ${url}/admin`);
|
|
34
|
+
console.log(` Docs: ${docsPath}`);
|
|
35
|
+
console.log('');
|
|
36
|
+
console.log(' Press Ctrl+C to stop.');
|
|
37
|
+
console.log('');
|
|
38
|
+
if (openBrowser) {
|
|
39
|
+
openUrl(url);
|
|
40
|
+
}
|
|
41
|
+
resolve();
|
|
42
|
+
});
|
|
43
|
+
});
|
|
44
|
+
}
|
|
45
|
+
function openUrl(url) {
|
|
46
|
+
const platform = process.platform;
|
|
47
|
+
if (platform === 'darwin')
|
|
48
|
+
(0, child_process_1.exec)(`open "${url}"`);
|
|
49
|
+
else if (platform === 'win32')
|
|
50
|
+
(0, child_process_1.exec)(`start "" "${url}"`);
|
|
51
|
+
else
|
|
52
|
+
(0, child_process_1.exec)(`xdg-open "${url}"`);
|
|
53
|
+
}
|
|
54
|
+
//# sourceMappingURL=server.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"server.js","sourceRoot":"","sources":["../../src/server.ts"],"names":[],"mappings":";;;;;AAaA,kCA+CC;AA5DD,sDAA8B;AAC9B,gDAAwB;AACxB,iDAAqC;AACrC,kDAAqD;AACrD,4CAA+C;AAC/C,yCAA2C;AAQpC,KAAK,UAAU,WAAW,CAAC,EAChC,QAAQ,EACR,IAAI,EACJ,WAAW,GAAG,KAAK,GACL;IACd,MAAM,GAAG,GAAG,IAAA,iBAAO,GAAE,CAAC;IAEtB,GAAG,CAAC,GAAG,CAAC,iBAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IAExB,4CAA4C;IAC5C,IAAA,oBAAW,EAAC,QAAQ,EAAE,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IAEtD,MAAM;IACN,GAAG,CAAC,GAAG,CAAC,gBAAgB,EAAE,IAAA,2BAAe,EAAC,QAAQ,CAAC,CAAC,CAAC;IACrD,GAAG,CAAC,GAAG,CAAC,aAAa,EAAE,IAAA,qBAAY,EAAC,QAAQ,CAAC,CAAC,CAAC;IAE/C,yBAAyB;IACzB,MAAM,YAAY,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IACtD,GAAG,CAAC,GAAG,CAAC,iBAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;IAEtC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,CACzB,GAAG,CAAC,QAAQ,CAAC,cAAI,CAAC,IAAI,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC,CACpD,CAAC;IACF,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,CAC9B,GAAG,CAAC,QAAQ,CAAC,cAAI,CAAC,IAAI,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC,CACpD,CAAC;IAEF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE;YACpB,MAAM,GAAG,GAAG,oBAAoB,IAAI,EAAE,CAAC;YACvC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAChB,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;YACtC,OAAO,CAAC,GAAG,CAAC,qCAAqC,CAAC,CAAC;YACnD,OAAO,CAAC,GAAG,CAAC,cAAc,GAAG,EAAE,CAAC,CAAC;YACjC,OAAO,CAAC,GAAG,CAAC,cAAc,GAAG,QAAQ,CAAC,CAAC;YACvC,OAAO,CAAC,GAAG,CAAC,cAAc,QAAQ,EAAE,CAAC,CAAC;YACtC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAChB,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;YACvC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAEhB,IAAI,WAAW,EAAE,CAAC;gBAChB,OAAO,CAAC,GAAG,CAAC,CAAC;YACf,CAAC;YAED,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,OAAO,CAAC,GAAW;IAC1B,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAClC,IAAI,QAAQ,KAAK,QAAQ;QAAE,IAAA,oBAAI,EAAC,SAAS,GAAG,GAAG,CAAC,CAAC;SAC5C,IAAI,QAAQ,KAAK,OAAO;QAAE,IAAA,oBAAI,EAAC,aAAa,GAAG,GAAG,CAAC,CAAC;;QACpD,IAAA,oBAAI,EAAC,aAAa,GAAG,GAAG,CAAC,CAAC;AACjC,CAAC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "living-documentation",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "A CLI tool that serves a local Markdown documentation viewer",
|
|
5
|
+
"main": "dist/src/server.js",
|
|
6
|
+
"bin": {
|
|
7
|
+
"living-documentation": "dist/bin/cli.js"
|
|
8
|
+
},
|
|
9
|
+
"files": [
|
|
10
|
+
"dist/",
|
|
11
|
+
"README.md"
|
|
12
|
+
],
|
|
13
|
+
"scripts": {
|
|
14
|
+
"build": "tsc && node scripts/copy-assets.js && chmod +x dist/bin/cli.js",
|
|
15
|
+
"dev": "ts-node bin/cli.ts",
|
|
16
|
+
"start": "node dist/bin/cli.js",
|
|
17
|
+
"prepublishOnly": "npm run build"
|
|
18
|
+
},
|
|
19
|
+
"keywords": [
|
|
20
|
+
"documentation",
|
|
21
|
+
"markdown",
|
|
22
|
+
"viewer",
|
|
23
|
+
"cli"
|
|
24
|
+
],
|
|
25
|
+
"author": "Youssef MEDAGHRI-ALAOUI",
|
|
26
|
+
"license": "MIT",
|
|
27
|
+
"dependencies": {
|
|
28
|
+
"commander": "^12.1.0",
|
|
29
|
+
"express": "^4.19.2",
|
|
30
|
+
"marked": "^12.0.0"
|
|
31
|
+
},
|
|
32
|
+
"devDependencies": {
|
|
33
|
+
"@types/express": "^4.17.21",
|
|
34
|
+
"@types/node": "^20.14.0",
|
|
35
|
+
"ts-node": "^10.9.2",
|
|
36
|
+
"typescript": "^5.4.5"
|
|
37
|
+
},
|
|
38
|
+
"engines": {
|
|
39
|
+
"node": ">=18.0.0"
|
|
40
|
+
}
|
|
41
|
+
}
|