Git Product home page Git Product logo

typescript-doc-gen's Introduction

typescript-doc-gen

一个快速将 TSX interface 转成 Markdown 的命令行工具

如何开始

npm install -g typescript-doc-gen
doc-gen
# 将`src\\Sample\\index.tsx`文件的interface提取出Markdown，默认保存到当前目录out下，注意在`.gitignore`文件里面添加out目录
doc-gen generate src\\Sample\\index.tsx

# or 将`src\\Sample\\index.tsx`文件的interface提取出Markdown 并保存到桌面
doc-gen generate src\\Sample\\index.tsx D:\\Users\\admin\\Desktop

功能

  • 识别 interface
  • 识别 extends，将其内容转化为子表格
  • 识别自定义类型，将其转化为子表并内链

TODO

  • 识别框架属性

  • 自动依赖分析

  • 批量识别

  • 支持 Markdown、HTML、PDF 等多种格式，可配置

  • 插件化

来喷源码

git clone [email protected]:rongfu.zhu/typescript-doc-gen.git
cd typescript-doc-gen
yarn
yarn gen

同类产品

api-hose

react-docgen-typescript

Documentation

typescript-doc-gen's People

Stargazers

avatar avatar

Watchers

avatar 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.