Git Product home page Git Product logo

mark-down-my-docs's Introduction

mark-down-my-docs

npm npm

MarkDown generator for .js and .ts source files with jsdoc documentation blocks

Why?

I was looking for an out-of-the-box, simple-to-setup documentation generator for a project of mine. So I could easily generate my documentation for this project. It was harder than it sounded, too hard. Turns out that it didn't exist, or I could not find it. That's why I created this package, hope it helps you as much as it helped me.

These were my demands

  1. Runs right away after installation without extra setup.
  2. Supports typescript and javascript.
  3. Supports jsdoc.
  4. Generates MarkDown files.
  5. Has as few dependencies as possible.
  6. Is fast
  7. Is a node application

Installation

npm install mark-down-my-docs 

Usage

Run command with source directory and docs directory.

mark-down-my-docs src/ docs/

mark-down-my-docs

Support

supports .js and .ts files with js-doc blocks

runs on node 14.x and 16.x

Suggestions?

Please create a new issue

Example docs generated by mark-down-my-docs

mark-down-my-docs's People

Contributors

mbroersen avatar

Stargazers

 avatar

Watchers

 avatar  avatar

mark-down-my-docs's Issues

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.