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

Markdown output ? One page for github readmes ? #20

Open
vindarel opened this issue Jan 9, 2017 · 2 comments
Open

Markdown output ? One page for github readmes ? #20

vindarel opened this issue Jan 9, 2017 · 2 comments

Comments

@vindarel
Copy link

vindarel commented Jan 9, 2017

Hi,
So far CommonDoc looks great and easy, but for my little project setting up github pages and CI to show the generated html is a bit too much. I'd like to generate a simple README with my doc and extracted docstrings that can be displayed by github. I also like the fact to show everything in the readme and not redirect to another website, when the documentation is small. Is there a way to achieve that ?

It looks like CommonDoc can not output markdown, can it ?

thanks !

@russell
Copy link

russell commented Jul 28, 2023

I know this is an old bug, but there is this library that adds support for markdown now https://github.com/40ants/commondoc-markdown

@svetlyak40wt
Copy link
Contributor

By the way, this library is written for my documentation generator https://40ants.com/doc/ and it does exactly what you want – generates HTML doc + updates README.md. Also, there is a helper to setup GitHub Actions for doing updates automatically.

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

3 participants