Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .config/.markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"extends": "../.markdownlint.json",
"MD051": false
}
58 changes: 58 additions & 0 deletions .config/typedoc.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
// @ts-check
/** @type {Partial<import("typedoc").TypeDocOptions> & Partial<import("typedoc-plugin-markdown").PluginOptions> & Partial<import("typedoc-plugin-remark").PluginOptions>} */
const config = {
entryPoints: ['../packages/annotation-comments/src/index.ts'],
tsconfig: '../packages/annotation-comments/tsconfig.json',
plugin: ['typedoc-plugin-markdown', 'typedoc-plugin-remark'],

// What to include in the output
disableSources: true,
excludeExternals: true,
excludeInternal: true,
excludePrivate: true,
excludeProtected: true,
hideGenerator: true,
hidePageHeader: true,
expandObjects: true,
expandParameters: true,
useCodeBlocks: true,
typeDeclarationVisibility: 'compact',

// Add custom preamble
mergeReadme: true,
readme: './typedoc.preamble.md',

// How to sort and group the output
sort: ['required-first', 'alphabetical'],
groupOrder: ['Classes', 'Constructors', 'Functions', 'Methods', 'Accessors', 'Variables', 'Interfaces', 'Type Aliases', '*'],

// Output location
outputFileStrategy: 'modules',

// Markdown-specific settings
outputs: [
{
name: 'markdown',
path: '../packages/annotation-comments',
options: {
cleanOutputDir: false,
},
},
],
remarkStringifyOptions: {
bullet: '-',
handlers: {
text: (node, _, state, info) => state.safe(node.value, info).replace(/\r?\n/g, ' '),
},
},
remarkPlugins: [
[
'remark-link-rewrite',
{
replacer: (url) => url.replace(/^.*?\.md#/g, '#'),
},
],
],
}

export default config
Loading