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

Feature Request: Generating documentation from a single README.md file #33

Open
pwittchen opened this issue Dec 20, 2017 · 1 comment
Open

Comments

@pwittchen
Copy link
Contributor

pwittchen commented Dec 20, 2017

Hi,

First of all, thanks for the great project! It's one of the best tools for generating websites with documentation I've found so far.

I think, it would be nice to have a feature, which allows to generate documentation from a single README.md file. I have a few small projects with documentation in a single file and I'd like to keep it like this for now. On the other hand, I'd like to use static to generate website with documentation, but in order to do that, I have to reorganize my documentation. I think, possibility of generating documentation in two ways (from multiple files and from a single file) would be useful.

Regards,
Piotr

@tj
Copy link
Member

tj commented Dec 20, 2017

Sounds reasonable to me!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants