opensource/lexical
1
0
Fork 0
mirror of https://github.com/facebook/lexical.git synced 2025-08-23 08:13:19 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat(@lexical/website): Packages documentation automatic generation (#5965)

Browse Source
This commit is contained in:
Bob Ippolito
2024-04-26 14:08:32 -07:00
committed by GitHub
parent 77f6faf467
commit f5b6f16be5
31 changed files with 108 additions and 197 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
scripts/create-docs.js
View File

@ -12,21 +12,6 @@ const fs = require('fs-extra');
const path = require('node:path');
const {packagesManager} = require('./shared/packagesManager');
const webPkg = packagesManager.getPackageByDirectoryName('lexical-website');
function sidebarTemplate(npmName, readmePath) {
return (
`
---
title: ''
sidebar_label: '${npmName}'
---
{@import ${readmePath}}
`.trim() + '\n'
);
}
function readmeTemplate(npmName, directoryName, description) {
const apiModuleName = directoryName.replace(/-/g, '_');
return (
@ -40,17 +25,12 @@ ${description}
);
}
function updateDocs() {
function createDocs() {
packagesManager.getPublicPackages().forEach((pkg) => {
const npmName = pkg.getNpmName();
const directoryName = pkg.getDirectoryName();
const root = pkg.resolve('..', '..');
const readmePath = pkg.resolve('README.md');
const sidebarPath = webPkg.resolve(
'docs',
'packages',
`${directoryName}.md`,
);
if (!fs.existsSync(readmePath)) {
console.log(`Creating ${path.relative(root, readmePath)}`);
fs.writeFileSync(
@ -63,17 +43,7 @@ function updateDocs() {
),
);
}
if (!fs.existsSync(sidebarPath)) {
console.log(`Creating ${path.relative(root, sidebarPath)}`);
fs.writeFileSync(
sidebarPath,
sidebarTemplate(
npmName,
path.relative(path.dirname(sidebarPath), readmePath),
),
);
}
});
}
updateDocs();
createDocs();