superopt/mkdocs.yml at master · smiles0527/superopt · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# MkDocs config for rendering the study notes as a local site.
#
#   pip install mkdocs-material mkdocs-roamlinks-plugin
#   mkdocs serve      # then open http://localhost:8000
#
# Nothing is hosted by this — it renders docs/notes/ locally. The built HTML
# goes to site/ (gitignored). Repo stays private.

site_name: Superopt notes
site_description: "Study notes for the superopt project: superoptimization, SMT, and CEGIS."

# Render the notes snapshot, not the whole repo.
docs_dir: docs/notes

theme:
  name: material
  palette:
    - scheme: default
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.top
    - navigation.instant
    - content.code.copy
    - search.suggest
    - search.highlight

nav:
  - Home: index.md
  - Theory:
      - Overview: theory/index.md
      - Superoptimization: theory/00-superoptimization.md
      - SMT & bit-vectors: theory/01-smt-and-bitvectors.md
      - Equivalence via UNSAT: theory/02-equivalence-via-unsat.md
      - Synthesis & constants: theory/03-synthesis-and-constants.md
      - CEGIS: theory/04-cegis.md
      - 'What "optimal" means': theory/05-optimality.md
  - Encodings:
      - Shifts: encodings/shifts.md
  - Papers:
      - Jha et al. 2010: papers/jha-2010.md

markdown_extensions:
  - admonition
  - toc:
      permalink: true
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - tables

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

plugins:
  - search
  - roamlinks   # converts Obsidian [[wikilinks]] into real relative links