search

adobe / hyde

A front-end to Jekyll that parses C++ sources to produce and enforce out-of-line documentation
http://opensource.adobe.com/hyde/
MIT License
323 stars 41 forks source link

Make Complete How-to from Running Hyde, Writing Documentation to Serving in Jekyll #62

Open mowijo opened 4 years ago

mowijo commented 4 years ago

Dear Authors.

I am very interested in documenting my C++ code in a different approach than the normal "XML/Doxygen inline" mess and as such have found Hyde. Unfortunately, I have a hard time using Hyde in conjunction with Jekyll.

I have build and run Hyde just fine, installed and served Jekyll fine, but still I dont know how to actually serve the markdown generated by Hyde and how to write documentation on the methods.

I would suggest a full end to end example on how to document code.

If somebody can help me getting to actually serve documentation with Jekyll with method and class codumentation written by me, I will be happy to write such a tutorial.

sean-parent commented 4 years ago

Although not a tutorial, make sure you check out the adobe/hyde-theme. Using this theme is probably the best way to get started at the moment. Leaving this issue open because I think a complete tutorial would have high value.

redtide commented 4 years ago

As references, other than the theme, I've found useful the stlab website (mentioned in the example section of the README) and the wiki. Once you have set up the configuration file and the build script for your requirements, it's all about to edit the resulting files (the __MISSING__ parts in the md files YAML frontmatters) and test them in Jekyll. Hope this also helps.