Code Monkey home page Code Monkey logo

typedoc-plugin-toc-group's Introduction

typedoc-plugin-toc-group

A plugin for TypeDoc that generate a menu for toc content list.

It can help you group your api list by @platformใ€@kindใ€@group. Just put the keywords to you code content then it will be ok when TypeDoc build over.

Installation

npm install --save-dev typedoc-plugin-toc-group

Usage

npx typedoc --out ./typings/doc  ./typings  --module umd --theme ./node_modules/typedoc-default-themes-extension/bin/default"

// or make a filter. if you don't want show Interfaces, we can use this
npx .... --tocg !256 --theme ./node_modules/typedoc-default-themes-extension/bin/default

the enum number were defined here: ReflectionKind

What does it look like?

demo-snapshot

Something else...

I have made a little change in typedoc-default-themes-extension

In order to show a bigger group title to users, you'd better install this theme first.

typedoc-plugin-toc-group's People

Contributors

blackmiaool avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.