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

Support markdown as output #599

Open
boc-tothefuture opened this issue Jan 23, 2021 · 2 comments
Open

Support markdown as output #599

boc-tothefuture opened this issue Jan 23, 2021 · 2 comments

Comments

@boc-tothefuture
Copy link

Please consider adding support for markdown as an output format. This would allow people to use pickles to embed the pickles generated documentation within the same look and feel of their other documentation.

@ericcmmi
Copy link
Member

There has been significant work done on the markdown format but it hasn't been pushed in a release yet. Will work on this. See this thread for further information on the current status of md support. #557 (comment)

@ericcmmi
Copy link
Member

ericcmmi commented Mar 9, 2021

@boc-tothefuture I didn't realize that Dirk had pushed the work that had been done on the markdown format so it is available in the 2.21 release. Use Pickles.exe --documentation-format=markdown or Pickles.exe -df=markdown. I know it was only the initial attempt at implementing it so try it out when you have a chance and let us know if you have any suggested improvements.

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