MCPcopy Index your code
hub / github.com/loopbackio/loopback-next / updateApiDocs

Function updateApiDocs

packages/tsdocs/src/update-api-md-docs.ts:26–53  ·  view source on GitHub ↗
(options: ApiDocsOptions = {})

Source from the content-addressed store, hash-verified

24 * @param options - Options for api docs
25 */
26export async function updateApiDocs(options: ApiDocsOptions = {}) {
27 options = Object.assign(
28 {
29 rootDir: process.cwd(),
30 apiDocsGenerationPath: DEFAULT_APIDOCS_GENERATION_PATH,
31 apiDocsExtractionPath: DEFAULT_APIDOCS_EXTRACTION_PATH,
32 generateDefaultPackageDoc: true,
33 },
34 options,
35 );
36 const packages = await getPackagesWithTsDocs(options.rootDir);
37
38 /* istanbul ignore if */
39 if (!packages.length) return;
40
41 const packagesByName: Record<string, LernaPackage> = {};
42
43 for (const pkg of packages) {
44 packagesByName[getUnscopedPackageName(pkg.name)] = pkg;
45 }
46
47 options.lernaPackages = packagesByName;
48
49 const found = await addJekyllMetadata(packages[0].rootPath, options);
50 if (found) {
51 // await generateIndex(packages, options);
52 }
53}
54
55/**
56 * Prepend Jekyll metadata to markdown files

Callers 2

mainFunction · 0.85

Calls 3

getPackagesWithTsDocsFunction · 0.90
getUnscopedPackageNameFunction · 0.90
addJekyllMetadataFunction · 0.85

Tested by

no test coverage detected