Did anything become of this @Mark_Wonsil ?
Looking at DocFx for internal documentation and found this template which adds some nice bits to handle TOC nav gen and output for optional SharePoint hosting, etc:
Demo:
Template repo:
Docs:
Happy Independence Day!
Yes, I’ve pivoted a bit here. Microsoft has abandoned DocFx for the Microsoft Learn Authoring Tools. DocFx is still an open source project, but the Learn Tools are just for authoring Learn content.
I’m less interested in the tool and focusing on DevOps cycle for maintaining documentation, something I alluded to at Insights this year. The idea is to maintain documentation in source control (or auto generate pieces from code) and use automated deployment.
Here are some tools that people use to do this:
This offers better control over a Wiki and still decentralizes the effort.
Makes sense for dev project docs such as apis etc. but DocFx is the sweet spot, IMHO, for simple md to static html w collab and source/version control. Adds some nice rendering over gh flavored md, no need for fancy material, react, etc.
It’s not going away. MkDocs is nice too but I haven’t compared in detail.
MS has requirements that internal/community docs never will such as multi-host, multi-culture, etc, etc which, as I understand is the main diff why docfx now only is but a part of the whole that’s now Learn tooling. <$0.02>
Absolutely pick the tool that works best. I love DocFx because, like you said, it does both API and static documentation. I’m focusing more on the process than the tool. Documentation should be pulled from code as much as possible. Maintaining it by hand gets out of sync all too easily. I liked this podcast that explains what we should be moving towards:
Of course, AI will most likely aid in automated code description as well.
I have recently started using mdoc. Love it we are probably going to standardize on this
Mkdocs + dcap CMS GitHub back end
Yeah, anything that’s takes Markdown that can be source controlled is going to work.