Skip to content

docs: add custom DocFX theme #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rian-be merged 1 commit into from
Jul 1, 2026
Merged

docs: add custom DocFX theme #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/publish-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ jobs:
with:
dotnet-version: 10.0.x

- name: Build release binaries
run: dotnet build ModularityKit.Mutator.slnx -c Release

- name: Install DocFX
run: dotnet tool update -g docfx

Expand Down
37 changes: 37 additions & 0 deletions Docs/Home.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
![ModularityKit.Mutator](../assets/brand/mutator-landing-banner.png)

# ModularityKit.Mutator

ModularityKit.Mutator is a .NET mutation runtime with governance, request lifecycle, approval flow,
and Redis-backed storage.

## Packages

| Package | What it covers |
| --- | --- |
| [`ModularityKit.Mutator`](../src/README.md) | mutation runtime, policies, execution, audit, history |
| [`ModularityKit.Mutator.Governance`](../src/Governance/README.md) | request lifecycle, approvals, resolution, governed execution |
| [`ModularityKit.Mutator.Governance.Redis`](../src/Redis/README.md) | Redis-backed storage and query provider |

## Explore

| Area | What to read |
| --- | --- |
| API reference | [`Docs/API/Reference.md`](API/Reference.md) |
| Core concepts | [`Docs/Core-Concepts.md`](Core-Concepts.md) |
| Execution model | [`Docs/ExecutionModel.md`](ExecutionModel.md) |
| Roadmap | [`Docs/Roadmap.md`](Roadmap.md) |

## What this site contains

- package overviews for the runtime and governance extensions
- conceptual docs for the mutation model and request flow
- generated API reference from XML docs

## Build locally

```bash
dotnet tool update -g docfx
dotnet build ModularityKit.Mutator.slnx -c Release
docfx docfx.json
```
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ Build the DocFX site locally with:

```bash
dotnet tool update -g docfx
dotnet build ModularityKit.Mutator.slnx -c Release
docfx docfx.json
```

Expand Down
22 changes: 9 additions & 13 deletions docfx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,13 @@
"src": [
{
"files": [
"src/ModularityKit.Mutator.csproj",
"src/ModularityKit.Mutator.Governance.csproj",
"src/Redis/ModularityKit.Mutator.Governance.Redis.csproj"
],
"exclude": [
"**/bin/**",
"**/obj/**"
"src/bin/Release/net10.0/ModularityKit.Mutator.dll",
"src/bin/Release/net10.0/ModularityKit.Mutator.Governance.dll",
"src/Redis/bin/Release/net10.0/ModularityKit.Mutator.Governance.Redis.dll"
]
}
],
"dest": "obj/api",
"properties": {
"Configuration": "Release",
"TargetFramework": "net10.0"
}
"dest": "obj/api"
}
],
"build": {
Expand Down Expand Up @@ -59,11 +51,15 @@
"dest": "_site",
"globalMetadata": {
"_appTitle": "ModularityKit.Mutator",
"_appName": "ModularityKit.Mutator",
"_appLogoPath": "assets/brand/logo.png",
"_appLogoUrl": "Docs/Home.html",
"_appFooter": "ModularityKit.Mutator documentation",
"_enableSearch": true
},
"template": [
"default"
"default",
"templates/modularitykit"
]
}
}
64 changes: 64 additions & 0 deletions templates/modularitykit/layout/_master.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}
{{!include(/^styles/.*/)}}
{{!include(/^fonts/.*/)}}
{{!include(favicon.ico)}}
{{!include(logo.svg)}}
{{!include(search-stopwords.json)}}
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html {{#_lang}}lang="{{_lang}}"{{/_lang}}>
{{>partials/head}}
{{^redirect_url}}
<body data-spy="scroll" data-target="#affix" data-offset="120">
<a class="skip-link" href="#_content">Skip to content</a>
<div class="site-topbar">
<div class="container site-topbar__inner">
<span class="site-topbar__brand">{{_appTitle}}</span>
<span class="site-topbar__text">Mutation runtime, governance, and generated API reference.</span>
</div>
</div>
<div id="wrapper" class="site-frame">
<header>
{{^_disableNavbar}}
{{>partials/navbar}}
{{/_disableNavbar}}
{{^_disableBreadcrumb}}
{{>partials/breadcrumb}}
{{/_disableBreadcrumb}}
</header>
{{#_enableSearch}}
<div class="container body-content">
{{>partials/searchResults}}
</div>
{{/_enableSearch}}
<div role="main" class="container body-content hide-when-search">
{{^_disableToc}}
{{>partials/toc}}
<div class="article row grid-right">
{{/_disableToc}}
{{#_disableToc}}
<div class="article row grid">
{{/_disableToc}}
{{#_disableAffix}}
<div class="col-md-12">
{{/_disableAffix}}
{{^_disableAffix}}
<div class="col-md-10">
{{/_disableAffix}}
<article class="content wrap" id="_content" data-uid="{{uid}}">
{{!body}}
</article>
</div>
{{^_disableAffix}}
{{>partials/affix}}
{{/_disableAffix}}
</div>
</div>
{{^_disableFooter}}
{{>partials/footer}}
{{/_disableFooter}}
</div>
{{>partials/scripts}}
</body>
{{/redirect_url}}
</html>
14 changes: 14 additions & 0 deletions templates/modularitykit/partials/footer.tmpl.partial
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}

<footer class="site-footer">
<div class="grad-bottom"></div>
<div class="footer">
<div class="container site-footer__inner">
<span class="site-footer__brand">ModularityKit.Mutator</span>
<span class="site-footer__text">Generated from XML docs and published from main.</span>
<span class="pull-right">
<a href="#top">{{__global.backToTop}}</a>
</span>
</div>
</div>
</footer>
35 changes: 35 additions & 0 deletions templates/modularitykit/partials/head.tmpl.partial
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}

<head>
<meta charset="utf-8">
{{#_googleAnalyticsTagId}}
<script async src="https://www.googletagmanager.com/gtag/js?id={{_googleAnalyticsTagId}}"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag() { dataLayer.push(arguments); }
gtag('js', new Date());
gtag('config', '{{_googleAnalyticsTagId}}');
</script>
{{/_googleAnalyticsTagId}}
{{#redirect_url}}
<meta http-equiv="refresh" content="0;URL='{{redirect_url}}'">
{{/redirect_url}}
{{^redirect_url}}
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<meta name="theme-color" content="#0f172a">
<title>{{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="{{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}">
{{#_description}}<meta name="description" content="{{_description}}">{{/_description}}
{{#description}}<meta name="description" content="{{description}}">{{/description}}
<link rel="shortcut icon" href="{{_rel}}{{{_appFaviconPath}}}{{^_appFaviconPath}}favicon.ico{{/_appFaviconPath}}">
<link rel="stylesheet" href="{{_rel}}styles/docfx.vendor.min.css">
<link rel="stylesheet" href="{{_rel}}styles/docfx.css">
<link rel="stylesheet" href="{{_rel}}styles/main.css">
<meta property="docfx:navrel" content="{{_navRel}}">
<meta property="docfx:tocrel" content="{{_tocRel}}">
{{#_noindex}}<meta name="searchOption" content="noindex">{{/_noindex}}
{{#_enableSearch}}<meta property="docfx:rel" content="{{_rel}}">{{/_enableSearch}}
{{#_enableNewTab}}<meta property="docfx:newtab" content="true">{{/_enableNewTab}}
{{/redirect_url}}
</head>
9 changes: 9 additions & 0 deletions templates/modularitykit/partials/logo.tmpl.partial
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}

<a class="navbar-brand site-brand" href="{{_rel}}{{{_appLogoUrl}}}{{^_appLogoUrl}}Docs/Home.html{{/_appLogoUrl}}">
<img id="logo" class="site-brand__logo" src="{{_rel}}{{{_appLogoPath}}}{{^_appLogoPath}}assets/brand/logo.png{{/_appLogoPath}}" alt="{{_appName}}">
<span class="site-brand__copy">
<span class="site-brand__title">{{_appTitle}}</span>
<span class="site-brand__subtitle">Docs</span>
</span>
</a>
29 changes: 29 additions & 0 deletions templates/modularitykit/partials/navbar.tmpl.partial
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}

<nav id="autocollapse" class="navbar navbar-inverse site-navbar ng-scope" role="navigation">
<div class="container">
<div class="navbar-header site-navbar__header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
{{>partials/logo}}
</div>
<div class="collapse navbar-collapse" id="navbar">
<ul class="nav navbar-nav site-nav">
<li><a href="{{_rel}}Docs/Home.html">Home</a></li>
<li><a href="{{_rel}}src/README.html">Core</a></li>
<li><a href="{{_rel}}src/Governance/README.html">Governance</a></li>
<li><a href="{{_rel}}src/Redis/README.html">Redis</a></li>
<li><a href="{{_rel}}Docs/API/Reference.html">API</a></li>
</ul>
<form class="navbar-form navbar-right site-search" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="{{__global.search}}" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
Loading
Loading