https://github.com/joshuajeschek/doctomd

JavaDoc to Markdown Converter
https://github.com/joshuajeschek/doctomd

Last synced: about 2 months ago
JSON representation

JavaDoc to Markdown Converter

• Host: GitHub
• URL: https://github.com/joshuajeschek/doctomd
• Owner: joshuajeschek
• License: mit
• Created: 2021-12-08T15:05:45.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-01-19T15:36:52.000Z (almost 3 years ago)
• Last Synced: 2024-04-25T13:01:27.231Z (9 months ago)
• Language: JavaScript
• Size: 26.4 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Javadoc to Markdown Converter

Converts JavaDoc to Markdown. Based on [delight-im/Javadoc-to-Markdown](https://github.com/delight-im/Javadoc-to-Markdown)

- Can convert a complete project

- support for frontmatter / standalone files

- Customize each Markdown File with Pre- and Post-Markdown Files (will be added in front or after content)

- Modules (can be added on GitHub)

⚠️ will delete the specified output directory before generating!

## Installation

```

npm i -g doctomd

```

## Usage

```

doctomd \

--input {input directory} \

--output {output directory} \

[--front {frontmatter directory}] \

[--pre {pre directory}] \

[--post {post directory}] \

[--module code] \

[--module hyphen] \

[--module link]

```

| flag     | description                                                                             | required |

| -------- | --------------------------------------------------------------------------------------- | -------- |

| `input`  | directory with input Java files                                                         | ✅       |

| `output` | directory for output Markdown files                                                     | ✅       |

| `front`  | directory with files for frontmatter. Can / Should also be used for standalone files    | ❌       |

| `pre`    | content of files in this directory is put after the heading and before the doc content. | ❌       |

| `post`   | content of files in this directory is put after the doc content                         | ❌       |

| `module` | currently available modules:  `code`, `hypen`, `link`                                   | ❌       |

For the files in the frontmatter / pre / post directories to matched with the input Java files, the directory structure and file names should be exactly the same (excluding the file extension)

---

## Contributing:

Feel free to post issues and develop this further.

### Testing your changes

- test directory should look like this:

    ```

    test

    ├─front

    │ └─...

    ├─input

    │ └─...

    ├─output

    │ └─...

    ├─post

    │ └─...

    └─pre

      └─...

    ```

- `npm run test`  

  (`node .\\bin\\doctomd --input test/input --output test/output --front test/front --pre test/pre --post test/post --module code --module hyphen --module link`)