Is there a program that allows you to write "pretty" library tutorials? [closed]
Questions asking us to recommend or find a tool, library or favorite off-site resource are off-topic for Stack Overflow as they tend to attract opinionated answers and spam. Instead, describe the problem and what has been done so far to solve it.
Closed 9 years ago.
Improve this questionI need to write tutorial for a library I wrote. The tutorial should also include co开发者_如何学运维de. I wonder if there is a platform/application that provides a nice option for writing such tutorials with code?
I would suggest write your documentation in Markdown syntax and publish the file on Github.
Sandcastle might help (it generates documentation files from XML code comments (assuming whatever language your library is written in supports this)). Though I'd describe the output as functional rather than pretty.
This pretty much depends on where and what format do you plan to publish your tutorial. For online publication (i.e. on a website, as HTML/CSS) you can use a syntax highlighter.
精彩评论