Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

deno doc: add Native Markdown Export Functionality #27090

Open
Aziz-TheDarkCode opened this issue Nov 26, 2024 · 1 comment
Open

deno doc: add Native Markdown Export Functionality #27090

Aziz-TheDarkCode opened this issue Nov 26, 2024 · 1 comment
Labels
cli related to cli/ dir suggestion suggestions for new features (yet to be agreed)

Comments

@Aziz-TheDarkCode
Copy link

Currently, the deno doc command provides documentation generation capabilities, but lacks a direct option to export documentation in Markdown (.md) format. This feature request proposes adding a --markdown or --md flag to enable seamless documentation export.

Add a new CLI flag to deno doc that allows exporting documentation as a Markdown file:

# Proposed usage
deno doc --markdown web/ui/button.tsx
deno doc --md web/ui/button.tsx
@lucacasonato lucacasonato added the suggestion suggestions for new features (yet to be agreed) label Nov 27, 2024
@lucacasonato
Copy link
Member

We already support HTML, JSON, and the CLI text output. Why do you need markdown instead of using the HTML output?

@lucacasonato lucacasonato added the cli related to cli/ dir label Nov 27, 2024
@lucacasonato lucacasonato changed the title Add Native Markdown Export Functionality deno doc: add Native Markdown Export Functionality Nov 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
cli related to cli/ dir suggestion suggestions for new features (yet to be agreed)
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@lucacasonato @Aziz-TheDarkCode