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.

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

deno doc --html : incorporate the content of the readme.md file into the documentation (if available) #27153

Open
iherman opened this issue Nov 29, 2024 · 0 comments
Labels
suggestion suggestions for new features (yet to be agreed)

Comments

@iherman
Copy link

iherman commented Nov 29, 2024

The issue title tells it all. It is always a good idea to write a GitHub readme.md file that would be some sort of an introduction to a package, but it should also be used as part of the documentation on the front page. Converting that file into the HTML index page is very helpful.

(I am obviously influenced by the fact that typedoc does exactly that, and I found that a really useful feature when writing a documentation.)

@crowlKats crowlKats added the suggestion suggestions for new features (yet to be agreed) label Nov 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
suggestion suggestions for new features (yet to be agreed)
Projects
None yet
Development

No branches or pull requests

2 participants