search

microsoft / PSDocs

Generate documentation from Infrastructure as Code (IaC).
MIT License
150 stars 24 forks source link

Add Docfx example #3

Open BernieWhite opened 7 years ago

BernieWhite commented 7 years ago

Provide an example of using PSDocs with Docfx.

wonsil commented 4 years ago

Hi Bernie, I've been thinking about taking information about an ERP system and creating DocFx markdown to document a particular instance. PSDoc looks exactly what I want. What do you want in a DocFx example that I may help with?

BernieWhite commented 4 years ago

@wonsil Thanks for your interest in PSDocs.

Ideally a walk though similar to Azure template, but anything in between is great. It's more about the process so that someone can understand how to integrate and run with DocFX. For example you may have to build a toc.yml file.

When including any output examples be sure to sanitize so that it doesn't contain real system names.