Awesome Docs
Welcome to Awesome Docs! This website showcases DocFx by using only conceptual docs. Conceptual means that everything is written by hand and not generated from comments within a code project.
Introduction
DocFx is an open source command line tool which allows you to create your own documentation website from Markdown files. The generated site will look and feel similar to learn.microsoft.com.
If you've never worked with Markdown or Yaml before, DocFx can look quite complicated. That's why I created this project. The goal of this site is to flatten the learning curve by providing scripts and functions which will make writing, building and publishing your DocFx site easier.
Hosting the Website
DocFx generates a static website consisting of HTML, CSS and JavaScript files which can be hosted on any webserver you like. This includes GitHub Pages, Azure Static Web Apps, Azure Storage Accounts or Azure App Services. This page will also show you how you can tweak it just a little bit so that it also runs on SharePoint Online. By hosting your Docs on SharePoint, you will not need an additional web server and you can leverage already exisitng permission groups. But the best part about it is that everything will be indexed and searchable in Microsoft 365 or even in Windows 11 Start Menu Search!
Next Steps
Note
All the code samples and information from this project are provided free of charge. If you like this page and the work I've put into this, please consider buying me a coffee on my GitHub Sponsors profile.