search

picklesdoc / pickles

The open source living documentation generator
http://www.picklesdoc.com/
Apache License 2.0
464 stars 164 forks source link

Support markdown as output #599

Open boc-tothefuture opened 3 years ago

boc-tothefuture commented 3 years ago

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 commented 3 years ago

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. https://github.com/picklesdoc/pickles/pull/557#issuecomment-519045815

ericcmmi commented 3 years ago

@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.