Getting Started

Mandatory Prerequisites

Dot Net SDK 7

• Install
• Verify

winget install Microsoft.DotNet.SDK.7

DocFx

• Install
• Update
• Verify

dotnet tool install -g --add-source 'https://api.nuget.org/v3/index.json' --ignore-failed-sources "docfx"

Optional Prerequisites

Prerequisites for Deployment on SharePoint Online

If you want to deploy your custom docs site to a SharePoint Online site, you need to install PowerShell 7 and the PnP.PowerShell Module as well.

PowerShell 7

• Install
• Verify

winget install --id Microsoft.Powershell --source winget

PnP.PowerShell Module

• Install
• Verify

Install-Module -Name PnP.PowerShell

Prerequisites for Deployment to Azure App Service

Az.Websites Module

• Install
• Verify

Install-Module -Name Az.Websites

Clone Repositories

awesome-docfx-template

• PowerShell
• Desktop

git clone https://github.com/mozziemozz/awesome-docfx-template.git

View on GitHub

M365CallFlowVisualizer

Note

If you want to use this to document your Teams call flows as well, you also need to clone the M365 Call Flow Visualizer repo to the same parent directory.

• PowerShell
• Desktop

git clone https://github.com/mozziemozz/M365CallFlowVisualizer.git

View on GitHub

Next Steps

• Initialize DocFx Project