https://github.com/timdeschryver/docs-md

Generate markdown docs for your project's public API
https://github.com/timdeschryver/docs-md

Last synced: 18 days ago
JSON representation

Generate markdown docs for your project's public API

• Host: GitHub
• URL: https://github.com/timdeschryver/docs-md
• Owner: timdeschryver
• Created: 2020-08-25T14:49:25.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2020-09-02T10:14:34.000Z (about 4 years ago)
• Last Synced: 2024-10-04T13:44:27.444Z (about 1 month ago)
• Language: TypeScript
• Size: 1.26 MB
• Stars: 16
• Watchers: 1
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# docs-md

Generate markdown docs for your project's public API.

## Usage

### Example

```

npx docs-md --help

  Description

    Generates documentation in markdown for your project

  Usage

    $ docs-md  [options]

  Options

    -o, --output     Api docs directory (comma seperated)  (default ./docs/api)

    -v, --version    Displays current version

    -h, --help       Displays this message

  Examples

    $ docs-md "./src/index.ts"

    $ docs-md "./src/project1/index.ts,./src/project2/index.ts"

    $ docs-md "./src/**/index.ts"

```