Repository navigation
Publish documentation on GitHub Pages with DocFX - #571
Closed
linkdotnet wants to merge 1 commit into
Closed
linkdotnet wants to merge 1 commit into
linkdotnet wants to merge 1 commit into
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
There are no active review issues for the documentation publishing changes.
No open issues 🎉
What changed in this PR
Publishes the existing Markdown documentation as a DocFX site on GitHub Pages, keeping docs/ as the source of truth.
Changes:
- Adds pinned DocFX tooling, site configuration, navigation, and a landing page.
- Adds documentation builds for pull requests and Pages deployment for pushes to
master. - Updates page headings, fixes an external documentation link, and documents local preview commands.
| File | Description |
|---|---|
| Readme.md | Links to the published site and explains local preview. |
| dotnet-tools.json | Pins the local DocFX tool. |
| docs/toc.yml | Defines site navigation. |
| docs/Storage/Readme.md | Promotes the page title to H1. |
| docs/Setup/Readme.md | Promotes the page title to H1. |
| docs/Setup/Docker.md | Promotes the page title to H1. |
| docs/Setup/Configuration.md | Promotes the page title to H1. |
| docs/SEO/Readme.md | Promotes the page title to H1. |
| docs/Migrations/UpgradeAssistant.md | Links to the tool README on GitHub. |
| docs/index.md | Adds the documentation landing page. |
| docs/Features/Styling.md | Promotes the page title to H1. |
| docs/Features/AdvancedFeatures.md | Promotes the page title to H1. |
| docs/Donations/Readme.md | Promotes the page title to H1. |
| docs/Comments/Readme.md | Promotes the page title to H1. |
| docs/Comments/Giscus.md | Promotes the page title to H1. |
| docs/Comments/Disqus.md | Promotes the page title to H1. |
| docs/Authorization/Readme.md | Promotes the page title to H1. |
| docs/Authorization/AzureAD.md | Promotes the page title to H1. |
| docs/Authorization/Auth0.md | Promotes the page title to H1. |
| docfx.json | Configures content, resources, theme, and site metadata. |
| .gitignore | Excludes generated DocFX output. |
| .github/workflows/docs.yml | Builds documentation with warnings as errors and deploys to Pages. |
Review effort: Balanced
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Publishes the existing markdown documentation in
docs/as a static site on GitHub Pages, rendered with DocFX.Why DocFX
dotnet-tools.json) and needs no Python toolchain (unlike MkDocs).docs/, so there is no second copy of the docs to keep in sync.MIGRATION.mdintodocs/resolve becausedocfx.jsonsits at the repo root.Changes
docfx.json,dotnet-tools.json,docs/toc.yml,docs/index.md: site configuration, navigation and landing page..github/workflows/docs.yml: builds with--warningsAsErrorson PRs (catches broken links), deploys to Pages on pushes tomaster.docs/became an absolute GitHub URL.Readme.mdlinks to the site and explains the local preview (dotnet tool restore, thendotnet docfx docfx.json --serve)..gitignoreignores_siteandobj.Verification
dotnet docfx docfx.json --warningsAsErrorsbuilds with 0 warnings, 0 errors.Configuration.mdsample JSON exists inappsettings.json.Screenshots
Landing page:
Configuration page:
Before merging
https://linkdotnet.github.io/Blog/. For the root of a domain, configure a custom domain (and add aCNAMEto the DocFX resources).