https://github.com/skatkov/yard-markdown

yard plugin to generate markdown documentation
https://github.com/skatkov/yard-markdown

markdown yard

Last synced: 9 days ago
JSON representation

yard plugin to generate markdown documentation

• Host: GitHub
• URL: https://github.com/skatkov/yard-markdown
• Owner: skatkov
• License: mit
• Created: 2023-10-30T22:29:53.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-08T23:59:57.000Z (2 months ago)
• Last Synced: 2024-09-09T00:46:40.927Z (2 months ago)
• Topics: markdown, yard
• Language: Ruby
• Homepage: https://poshtui.com
• Size: 67.4 KB
• Stars: 11
• Watchers: 2
• Forks: 1
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Yard::Markdown

Yard plugin to generate markdown documentation

## Goals:

- Compatible with Github Flavored Markdown

- Mimick yard html layout where it makes sense to maintain familiarity

- Produce .csv index file alonside markdown documentation to act as file index

- Include markdown files that are already present in source code.

## Usage

Yard doesn't load plugin by default, so you need to load plugin through `~/.yard/config`:

```yaml

!!!yaml

load_plugins: true

autoload_plugins:

  - markdown

```

Install a plugin

```

gem install yard-markdown

```

Run `yardoc --format=markdown` to generate markdown documentation.

## Backstory

This is a successor to [rdoc-mardown gem](https://github.com/skatkov/rdoc-markdown/tree/main/example) with small differences in implementation. This gem was written to power API documentation browser CLI app for ruby developers called [POSH TUI](https://poshtui.com).

## Testing

Unit tests can't really test this gem properly. So it's semi-manual process of making changes and reviewing output.

  `yardoc example.rb` -> outputs everything into example/ folder.