adobe / adobe/hyde

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

Open
#62 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
340
Forks
45
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.