29044867dd
This PR adds the docs app back into the tldraw monorepo. ## Deploying We'll want to update our deploy script to update the SOURCE_SHA to the newest release sha... and then deploy the docs pulling api.json files from that release. We _could_ update the docs on every push to main, but we don't have to unless something has changed. Right now there's no automated deployments from this repo. ## Side effects To make this one work, I needed to update the lock file. This might be ok (new year new lock file), and everything builds as expected, though we may want to spend some time with our scripts to be sure that things are all good. I also updated our prettier installation, which decided to add trailing commas to every generic type. Which is, I suppose, [correct behavior](https://github.com/prettier/prettier-vscode/issues/955)? But that caused diffs in every file, which is unfortunate. ### Change Type - [x] `internal` — Any other changes that don't affect the published package[^2]
93 lines
2.5 KiB
TypeScript
93 lines
2.5 KiB
TypeScript
import { InputSection } from '@/types/content-types'
|
|
import { nicelog } from '@/utils/nicelog'
|
|
import { ApiModel } from '@microsoft/api-extractor-model'
|
|
import fs from 'fs'
|
|
import path from 'path'
|
|
import { CONTENT_DIR, getSlug } from '../utils'
|
|
import { getApiMarkdown } from './getApiMarkdown'
|
|
|
|
export async function createApiMarkdown() {
|
|
const apiInputSection: InputSection = {
|
|
id: 'gen' as string,
|
|
title: 'API Reference',
|
|
description: "Reference for the tldraw package's APIs (generated).",
|
|
categories: [],
|
|
sidebar_behavior: 'show-title',
|
|
}
|
|
|
|
const addedCategories = new Set<string>()
|
|
|
|
const INPUT_DIR = path.join(process.cwd(), 'api')
|
|
const OUTPUT_DIR = path.join(CONTENT_DIR, 'gen')
|
|
|
|
if (fs.existsSync(OUTPUT_DIR)) {
|
|
fs.rmSync(OUTPUT_DIR, { recursive: true })
|
|
}
|
|
|
|
fs.mkdirSync(OUTPUT_DIR)
|
|
|
|
const model = new ApiModel()
|
|
const packageModels = []
|
|
|
|
// get all files in the INPUT_DIR
|
|
const files = fs.readdirSync(INPUT_DIR)
|
|
for (const file of files) {
|
|
// get the file path
|
|
const filePath = path.join(INPUT_DIR, file)
|
|
|
|
// parse the file
|
|
const apiModel = model.loadPackage(filePath)
|
|
|
|
// add the parsed file to the packageModels array
|
|
packageModels.push(apiModel)
|
|
}
|
|
|
|
await Promise.allSettled(
|
|
packageModels.map(async (packageModel) => {
|
|
const categoryName = packageModel.name.replace(`@tldraw/`, '')
|
|
|
|
if (!addedCategories.has(categoryName)) {
|
|
apiInputSection.categories!.push({
|
|
id: categoryName,
|
|
title: packageModel.name,
|
|
description: '',
|
|
groups: [
|
|
'Namespace',
|
|
'Class',
|
|
'Function',
|
|
'Variable',
|
|
'Enum',
|
|
'Interface',
|
|
'TypeAlias',
|
|
].map((title) => ({
|
|
id: title,
|
|
path: null,
|
|
})),
|
|
})
|
|
addedCategories.add(categoryName)
|
|
}
|
|
|
|
const entrypoint = packageModel.entryPoints[0]
|
|
|
|
for (let j = 0; j < entrypoint.members.length; j++) {
|
|
const item = entrypoint.members[j]
|
|
|
|
const result = await getApiMarkdown(categoryName, item, j)
|
|
const outputFileName = `${getSlug(item)}.mdx`
|
|
nicelog(`✎ ${outputFileName}`)
|
|
fs.writeFileSync(path.join(OUTPUT_DIR, outputFileName), result.markdown)
|
|
}
|
|
})
|
|
)
|
|
|
|
// Add the API section to the sections.json file
|
|
|
|
const sectionsJsonPath = path.join(CONTENT_DIR, 'sections.json')
|
|
const sectionsJson = JSON.parse(fs.readFileSync(sectionsJsonPath, 'utf8')) as InputSection[]
|
|
sectionsJson.splice(
|
|
sectionsJson.findIndex((s) => s.id === 'gen'),
|
|
1
|
|
)
|
|
sectionsJson.push(apiInputSection)
|
|
fs.writeFileSync(sectionsJsonPath, JSON.stringify(sectionsJson, null, 2))
|
|
}
|