Have ideas to improve npm?Join in the discussion! »

    typedoc-hugo-theme
    TypeScript icon, indicating that this package has built-in type declarations

    0.2.0 • Public • Published

    typedoc-hugo-theme

    A Hugo compatible Markdown theme extended from typedoc-plugin-markdown.

    npm

    What is does?

    Installation

    npm install typedoc typedoc-plugin-markdown typedoc-hugo-theme --save-dev

    Usage

    $ npx typedoc --plugin typedoc-plugin-markdown --theme ./node_modules/typedoc-hugo-theme/dist ...options

    Output

    Example page

    ---
    title: "Class: SomeClass"
    slug: "module.someclass"
    linkTitle: "SomeClass"
    ---
    
    + page contents
    

    Example directory

    classes
    └─── _index.md
    └─── ClassA.md
    └─── ClassB.md
    

    Keywords

    Install

    npm i typedoc-hugo-theme

    DownloadsWeekly Downloads

    20

    Version

    0.2.0

    License

    MIT

    Unpacked Size

    8.88 kB

    Total Files

    6

    Last publish

    Collaborators

    • avatar