Docs - Reference Source Extension #203
Unanswered
TheBrambleShark
asked this question in
Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
I am looking at making an extension to Statiq.docs which generates of browsable source code documents in a style similar to source.dot.net.
Most of the legwork has been done for us with the existing Api pipeline, especially since Roslyn is already parsing the source documents. This just effectively needs to re-render the document as a source view and have various code elements such as type names be clickable, optionally linking back to source.dot.net for BCL types (or as a stretch goal, downloading selected types or namespaces for direct inclusion).
What I'm not sure of is what sort of direction this needs to go. Do I need a pipeline, perhaps depending on the API pipeline, to reconstruct the source code with interactive elements? Or does the existing API pipeline provide everything I need and I just need to define a razor template? Unlike Statiq.Docs, rendering a code view is going to be rather opinionated, so I'm ok with bundling everything into one solution.
Could I get some guidance on what sort of components I might need for this or some pointers in getting started? Also, if this goes anywhere I'm completely open to making this available under the Statiq library under whatever license works best. I'm sure this will be useful to others, not just me.
Beta Was this translation helpful? Give feedback.
All reactions