Skip to content

Commit b184f5f

Browse files
rian-berian-be
committed
docs: add root DocFX homepage
1 parent 74ab123 commit b184f5f

7 files changed

Lines changed: 159 additions & 3 deletions

File tree

‎.github/workflows/publish-docs.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ jobs:
3535
- name: Build docs
3636
run: docfx docfx.json
3737

38+
- name: Copy root index
39+
run: cp index.html _site/index.html
40+
3841
- name: Mark site as non-Jekyll
3942
run: touch _site/.nojekyll
4043

‎Docs/Home.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,5 @@ and Redis-backed storage.
3434
dotnet tool update -g docfx
3535
dotnet build ModularityKit.Mutator.slnx -c Release
3636
docfx docfx.json
37+
cp index.html _site/index.html
3738
```

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ Build the DocFX site locally with:
4545
dotnet tool update -g docfx
4646
dotnet build ModularityKit.Mutator.slnx -c Release
4747
docfx docfx.json
48+
cp index.html _site/index.html
4849
```
4950

5051
The generated site includes the conceptual docs under `Docs/` and the public API reference for the

‎docfx.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040
"resource": [
4141
{
4242
"files": [
43+
"index.html",
4344
"assets/**"
4445
],
4546
"exclude": [
@@ -53,7 +54,7 @@
5354
"_appTitle": "ModularityKit.Mutator",
5455
"_appName": "ModularityKit.Mutator",
5556
"_appLogoPath": "assets/brand/logo.png",
56-
"_appLogoUrl": "Docs/Home.html",
57+
"_appLogoUrl": "index.html",
5758
"_appFooter": "ModularityKit.Mutator documentation",
5859
"_enableSearch": true
5960
},

‎index.html‎

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
<title>ModularityKit.Mutator</title>
8+
<style>
9+
:root {
10+
color-scheme: light;
11+
--bg: #f6f7f9;
12+
--card: #ffffff;
13+
--border: #d9dee7;
14+
--text: #122033;
15+
--muted: #5b6778;
16+
--accent: #143a5a;
17+
--accent-strong: #0d2940;
18+
}
19+
20+
html, body {
21+
margin: 0;
22+
min-height: 100%;
23+
background: var(--bg);
24+
color: var(--text);
25+
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif;
26+
}
27+
28+
.page {
29+
max-width: 980px;
30+
margin: 0 auto;
31+
padding: 32px 20px 48px;
32+
}
33+
34+
.hero {
35+
background: var(--card);
36+
border: 1px solid var(--border);
37+
border-radius: 8px;
38+
box-shadow: 0 1px 2px rgba(18, 32, 51, 0.04);
39+
overflow: hidden;
40+
}
41+
42+
.hero__banner {
43+
display: block;
44+
width: 100%;
45+
height: auto;
46+
}
47+
48+
.hero__body {
49+
padding: 28px;
50+
}
51+
52+
h1 {
53+
margin: 0 0 12px;
54+
font-size: 2rem;
55+
line-height: 1.1;
56+
}
57+
58+
p {
59+
margin: 0 0 18px;
60+
color: var(--muted);
61+
line-height: 1.55;
62+
}
63+
64+
.grid {
65+
display: grid;
66+
grid-template-columns: repeat(2, minmax(0, 1fr));
67+
gap: 16px;
68+
margin-top: 24px;
69+
}
70+
71+
.card {
72+
background: var(--card);
73+
border: 1px solid var(--border);
74+
border-radius: 8px;
75+
padding: 18px;
76+
}
77+
78+
.card h2 {
79+
margin: 0 0 10px;
80+
font-size: 1rem;
81+
}
82+
83+
.links {
84+
display: grid;
85+
gap: 8px;
86+
}
87+
88+
.links a {
89+
color: var(--accent);
90+
text-decoration: none;
91+
font-weight: 600;
92+
}
93+
94+
.links a:hover,
95+
.links a:focus {
96+
color: var(--accent-strong);
97+
text-decoration: underline;
98+
}
99+
100+
@media (max-width: 720px) {
101+
.page {
102+
padding: 16px 12px 32px;
103+
}
104+
105+
.hero__body {
106+
padding: 20px;
107+
}
108+
109+
.grid {
110+
grid-template-columns: 1fr;
111+
}
112+
}
113+
</style>
114+
</head>
115+
<body>
116+
<main class="page">
117+
<section class="hero">
118+
<img class="hero__banner" src="assets/brand/mutator-landing-banner.png" alt="ModularityKit.Mutator">
119+
<div class="hero__body">
120+
<h1>ModularityKit.Mutator</h1>
121+
<p>Mutation runtime, governance, and generated API reference for .NET.</p>
122+
<div class="links">
123+
<a href="Docs/Home.html">Open documentation site</a>
124+
<a href="Docs/API/Reference.html">Open API reference</a>
125+
</div>
126+
</div>
127+
</section>
128+
129+
<section class="grid" aria-label="Documentation sections">
130+
<article class="card">
131+
<h2>Packages</h2>
132+
<div class="links">
133+
<a href="src/README.html">ModularityKit.Mutator</a>
134+
<a href="src/Governance/README.html">ModularityKit.Mutator.Governance</a>
135+
<a href="src/Redis/README.html">ModularityKit.Mutator.Governance.Redis</a>
136+
</div>
137+
</article>
138+
139+
<article class="card">
140+
<h2>Guides</h2>
141+
<div class="links">
142+
<a href="Docs/Core-Concepts.html">Core concepts</a>
143+
<a href="Docs/ExecutionModel.html">Execution model</a>
144+
<a href="Docs/Roadmap.html">Roadmap</a>
145+
</div>
146+
</article>
147+
</section>
148+
</main>
149+
</body>
150+
</html>

‎templates/modularitykit/partials/navbar.tmpl.partial‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
</div>
1414
<div class="collapse navbar-collapse" id="navbar">
1515
<ul class="nav navbar-nav site-nav">
16-
<li><a href="{{_rel}}Docs/Home.html">Home</a></li>
16+
<li><a href="{{_rel}}index.html">Home</a></li>
1717
<li><a href="{{_rel}}src/README.html">Core</a></li>
1818
<li><a href="{{_rel}}src/Governance/README.html">Governance</a></li>
1919
<li><a href="{{_rel}}src/Redis/README.html">Redis</a></li>

‎toc.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
- name: Home
2-
href: Docs/Home.md
2+
href: index.html
33
- name: Packages
44
items:
55
- name: ModularityKit.Mutator

0 commit comments

Comments
 (0)