Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Support full/extended markdown syntax #66
Included documents would benefit from using full Markdown syntax. Extended syntax is also welcome. Although it would be possible to implement this directly within appledoc source, it's probably better to use third party library such as discount.
In any case it would be preferrable to use the same solution for both, code comments and included documents parsing. There are couple of issues with using third party libraries (all depend on actual library used!):
This took quite a bit longer than estimated, but was worth it as now full Markdown syntax is supported (with extensions). Instead of doing internal parsing of source code, I embedded Discount for this. Check the documentation to see all options it supports!
Documentation is now 100% Markdown compatible, although several appledoc features are preserved and change default Markdown syntax:
Generally the documentation should be backwards compatible, so most users won't notice a difference, but there are a couple of points that are handled differently now with Discount, so some may experience different layout in the generated HTML files. You should now follow Markdown syntax. Perhaps most noticeable: example blocks following list item are now treated as continuation of list item, whereas before they were converted to example blocks. Hopefully these changes are for the best and definitely more in-spec with Markdown... If you experience some strange behavior, open a new issue or comment on this one...
IMPORTANT: Don't forget to update template files!
NOTE: Actually this commit only updates version, the actual solution was implemented on a temporary branch, merged to development at b7b92f8. The actual implementation starts at 1ad2f9d and ends with 226b767. GitHub still doesn't support linking commits to issues beyond closing... Not too elegant, but this was far too large to be handled by a single commit!