Skip to content

Commit 6d291ee

Browse files
committed
docs: enable edit links, custom styles, and extra markdown features on the site
1 parent 602c10f commit 6d291ee

2 files changed

Lines changed: 93 additions & 0 deletions

File tree

docs/assets/css/custom.css

Lines changed: 52 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/sarde.yaml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ site:
22
title: "Sarde"
33
description: "Documentation for Sarde, a zero-config static site generator"
44
url: "https://getsarde.github.io"
5+
edit_url: "https://github.com/getsarde/sarde/edit/main/docs/content"
56

67
build:
78
# Project site at https://getsarde.github.io/sarde/
@@ -11,6 +12,22 @@ theme:
1112
name: "default"
1213
preset: "docs"
1314

15+
head:
16+
custom_css:
17+
- css/custom.css
18+
19+
markdown:
20+
github_alerts: true
21+
katex: true
22+
mermaid: true
23+
triple_colon_callouts: true
24+
typographer: true
25+
unsafe: false
26+
codeblocks:
27+
engine: nuri
28+
light_theme: "github-light"
29+
dark_theme: "github-dark-default"
30+
1431
collections:
1532
docs:
1633
sort: "order"
@@ -35,7 +52,17 @@ plugins:
3552
- link_validator
3653
- redirects
3754
- social_cards
55+
- scroll-to-top
3856
- keyboard-nav
57+
config:
58+
scroll-to-top:
59+
showProgressRing: true
60+
showTooltip: true
61+
keyboard-nav:
62+
# Keep arrow-key navigation, drop the on-load hint toast and the
63+
# chevron arrows pinned to the viewport edges.
64+
show_hint: false
65+
show_side_nav: true
3966

4067
homepage:
4168
hero:
@@ -52,3 +79,17 @@ homepage:
5279
light: /images/hero-light.svg
5380
dark: /images/hero-dark.svg
5481
alt: "Hero illustration"
82+
social:
83+
- icon: github
84+
label: GitHub
85+
url: https://github.com/getsarde/sarde
86+
87+
header:
88+
links:
89+
- label: Tags
90+
url: /tags/
91+
- label: Changelog
92+
url: /docs/changelog
93+
search: true
94+
social: true
95+
theme_toggle: true

0 commit comments

Comments
 (0)