How to use typedoc-plugin-markdown - 2 common examples

To help you get started, we’ve selected a few typedoc-plugin-markdown examples, based on popular ways it is used in public projects.

Secure your code as it's written. Use Snyk Code to scan source code in minutes - no build needed - and fix issues immediately.

github microsoft / fast-dna / packages / fast-components-react-msft / typedoc-theme / helpers-src / member-type.ts View on Github external
export function memberType(this: DeclarationReflection): string {
    const md: string[] = [];

    if (this.type) {
        md.push(type.call(this.type));
    }
    if (this.defaultValue) {
        md.push(`= ${this.defaultValue}`);
    }

    return md.join(" ");
}
github MozillaReality / ecsy / docs / theme / theme.js View on Github external
const Handlebars = require("handlebars");

const MarkdownTheme = require("typedoc-plugin-markdown/dist/theme").default;
class CustomMarkdownTheme extends MarkdownTheme {
  constructor(renderer, basePath) {
    super(renderer, basePath);
  }
}
exports.default = CustomMarkdownTheme;

typedoc-plugin-markdown

A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.

MIT
Latest version published 10 days ago

Package Health Score

89 / 100
Full package analysis