Skip to content

Commit dd77353

Browse files
author
William DeMeo
committed
adopt new build, add sts png, add global links
1 parent c56a446 commit dd77353

File tree

5 files changed

+176
-121
lines changed

5 files changed

+176
-121
lines changed

mkdocs/src/docs/Notation.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The *sum* (or disjoint union, coproduct, etc.) of `A`{.agdabound} and
2626
`B`{.agdabound} is denoted by
2727
`A`{.agdabound} ``{.agdadatatype} `B`{.agdabound}, and their product
2828
is denoted by `A`{.agdabound} `×`{.agdafunction} `B`{.agdabound}. The
29-
projection functions from products are denoted \fst{} and \snd{},
29+
projection functions from products are denoted
3030
`proj₁`{.agdafield} and `proj₂`{.agdafield} and the injections are denoted
3131
`inj₁`{.agdainductiveconstructor} and
3232
`inj₂`{.agdainductiveconstructor}, respectively. The
@@ -60,7 +60,6 @@ write
6060
`.`{.agdasymbol}
6161
`proj₁`{.agdafield}
6262
instead of
63-
6463
`proj₁`{.agdafield}
6564
`x`{.agdabound}
6665

@@ -201,6 +200,6 @@ and can safely be ignored. However there are the two exceptions:
201200

202201
- ``{.agdafunction}in the context of set restrictions, where it indicates the complement
203202

204-
Also, non-letter superscripts do carry meaning.[^1]
203+
Also, non-letter superscripts do carry meaning.
205204

206-
[^1]: At some point in the future we hope to be able to remove all those non-essential superscripts. Since we prefer doing this by changing the Agda source code instead of via hiding them in this document, this is a non-trivial problem that will take some time to address.
205+
(At some point in the future we hope to be able to remove all those non-essential superscripts. Since we prefer doing this by changing the Agda source code instead of via hiding them in this document, this is a non-trivial problem that will take some time to address.)
195 KB
Loading

mkdocs/src/includes/links.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
[Agda documentation]: https://agda.readthedocs.io/en/
2+
[Agda Essentials]: EssentialAgda.md
3+
[Agda Wiki]: https://wiki.portal.chalmers.se/agda/pmwiki.php
4+
[Auxiliary DELEG transition system]: Ledger.Conway.Certs.md#auxiliary-deleg-transition-system
5+
[Auxiliary GOVCERT transition system]: Ledger.Conway.Certs.md#auxiliary-govcert-transition-system
6+
[Auxiliary POOL transition system]: Ledger.Conway.Certs.md#auxiliary-pool-transition-system
7+
[CERT]: Ledger.Conway.Certs.md#certs-rules
8+
[CERTS]: Ledger.Conway.Certs.md#certs-rules
9+
[CERTS rules]: Ledger.Conway.Certs.md#certs-rules
10+
[CHAIN]: Ledger.Conway.Chain.md#chain-transition-system
11+
[DELEG]: Ledger.Conway.Certs.md#auxiliary-deleg-transition-system
12+
[ENACT]: Ledger.Conway.Enact.md#enact-transition-system
13+
[EPOCH]: Ledger.Conway.Epoch.md#epoch-transition-system
14+
[GOV]: Ledger.Conway.Gov.md#rules-for-the-gov-transition-system
15+
[GOVCERT]: Ledger.Conway.Certs.md#auxiliary-govcert-transition-system
16+
[issues]: https://github.com/IntersectMBO/formal-ledger-specifications/issues
17+
[LEDGER]: Ledger.Conway.Ledger.md#ledger-transition-system
18+
[LEDGERS]: Ledger.Conway.Ledger.md#ledgers-transition-system
19+
[NEWEPOCH]: Ledger.Conway.Epoch.md#newepoch-transition-system
20+
[Notation]: Notation.md
21+
[POOL]: Ledger.Conway.Certs.md#auxiliary-pool-transition-system
22+
[RATIFY]: Ledger.Conway.Ratify.md#the-ratify-transition-system
23+
[repourl]: https://github.com/IntersectMBO/formal-ledger-specifications
24+
[SNAP]: Ledger.Conway.Rewards.md#snap-transition-system
25+
[UTXO]: Ledger.Conway.Utxo.md#utxo-inference-rules
26+
[UTXOS]: Ledger.Conway.Utxo.md#utxos-rule
27+
[UTXOW]: Ledger.Conway.Utxow.md#utxow-inference-rules
28+
[Shelley Ledger Spec (pdf)]: https://github.com/intersectmbo/cardano-ledger/releases/latest/download/shelley-ledger.pdf

mkdocs/src/mkdocs.yml

Lines changed: 28 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,14 @@ theme:
1717
- toc.integrate # Integrate table of contents into left sidebar
1818
- content.tooltips
1919
- navigation.footer
20-
# palette: # Optional: color scheme
21-
# primary: indigo
22-
# accent: indigo
23-
2420
palette:
2521
# Dark Mode
2622
- scheme: slate
2723
toggle:
2824
icon: material/weather-sunny
2925
name: Dark mode
30-
primary: black
31-
accent: red
26+
primary: black # indigo
27+
accent: red # indigo
3228

3329
# Light Mode
3430
- scheme: default
@@ -38,35 +34,42 @@ theme:
3834
primary: blue
3935
accent: deep orange
4036

41-
# Font configuration (optional)
37+
# Font configuration
4238
font:
4339
text: Cambria
4440
code: Source Code Pro
45-
# text: Roboto
46-
# code: Roboto Mono # Or perhaps StrippedJuliaMono if available via CSS?
4741

42+
extra_css:
43+
- css/custom.css
44+
- css/Agda.css
4845

49-
# Navigation structure
50-
nav:
51-
- Home: index.md
46+
extra_javascript:
47+
- js/custom.js
48+
- https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
5249

53-
# Markdown extensions
5450
markdown_extensions:
55-
- admonition # call-out boxes like !!! note
51+
- pymdownx.arithmatex:
52+
generic: true
53+
- admonition
5654
- pymdownx.details
57-
- toc: # table of contents generation
58-
permalink: true # anchor links to headers
59-
- pymdownx.superfences: # syntax highlighting in code blocks
55+
- toc:
56+
permalink: "#"
57+
- pymdownx.superfences:
6058
custom_fences:
61-
- name: mermaid # mermaid diagrams
59+
- name: mermaid
6260
class: mermaid
63-
- attr_list # inline attributes like `code`{.class}
64-
- pymdownx.tabbed
61+
- attr_list
6562
- pymdownx.emoji
63+
- pymdownx.snippets:
64+
check_paths: true # for debugging
65+
auto_append:
66+
- includes/links.md
6667

67-
extra_css:
68-
- css/custom.css
69-
- css/Agda.css
68+
watch:
69+
- includes
7070

71-
extra_javascript:
72-
- js/custom.js
71+
use_directory_urls: false
72+
73+
# Navigation structure
74+
nav:
75+
- Home: index.md

0 commit comments

Comments
 (0)