website/mkdocs.yml at main · cara-lang/website · 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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
site_name: Cara
site_url: https://cara-lang.com/
site_author: Martin Janiczek (@janiczek)
site_description: Cara programming language
repo_url: https://github.com/cara-lang/compiler
copyright: Made with 🧡 by <u><a href="https://github.com/janiczek">Martin Janiczek</a></u>
edit_uri: https://github.com/cara-lang/website/edit/main/docs/
nav:
    - Home: index.md
    - Reference:
      - reference/index.md
      - Anonymous functions and holes: reference/anonymous-fns-and-holes.md
      - Tests: reference/tests.md
      - Numbers: reference/numbers.md
      - Booleans: reference/booleans.md
      - Characters and strings: reference/chars-and-strings.md
      - Collections: reference/collections.md
      - Records: reference/records.md
      - Tuples: reference/tuples.md
      - Algebraic data types: reference/adts.md
      - Functions: reference/fns.md
      - Function overloading: reference/fn-overloading.md
      - Type classes: reference/type-classes.md
      - Type aliases: reference/type-aliases.md
      - Type annotations: reference/type-annotations.md
      - Standard library: reference/stdlib.md
      - Operators: reference/operators.md
      - Statements and blocks: reference/statements-and-blocks.md
      - Where: reference/where.md
      - Maybe and Result: reference/maybe-and-result.md
      - Pipelines: reference/pipelines.md
      - Dot chaining: reference/dot.md
      - Comments: reference/comments.md
      - If expressions: reference/if.md
      - Case expressions and pattern matching: reference/case.md
      - Pattern guards: reference/guards.md
      - Imports, exports and modules: reference/imports-exports-modules.md
      - GADTs: reference/gadts.md
    - Principles:
      - principles/index.md
      - Zen of Cara: principles/zen.md
      - Functional programming: principles/fp.md
      - Immutability: principles/immutability.md
      - Purity and effects: principles/purity-and-effects.md
      - Build modules around data structures: principles/build-modules-around-data-structures.md
      - Make impossible states impossible: principles/make-impossible-states-impossible.md
      - Common patterns:
        - principles/common-patterns/index.md
        - "map: Functor": principles/common-patterns/functor.md
        - "andMap, map2: Applicative": principles/common-patterns/applicative.md
        - "orElse: Alternative": principles/common-patterns/alternative.md
        - "concat: Semigroup": principles/common-patterns/semigroup.md
        - "empty: Monoid": principles/common-patterns/monoid.md
        - "andThen, flatMap: Monad": principles/common-patterns/monad.md
        - "fold, reduce: Foldable": principles/common-patterns/foldable.md
        - "sequence, traverse: Traversable": principles/common-patterns/traversable.md
    - Guides:
      - guides/index.md
      - Cara for Elm developers: guides/cara-for-elm-devs.md
      - Cara for Haskell developers: guides/cara-for-hs-devs.md
      - Cara for JS/Python/Kotlin developers: guides/cara-for-js-py-kt-devs.md
      - Working with ADTs: guides/adts.md
      - Testing: guides/testing.md
      - Performance and parallelism: guides/perf-and-parallelism.md
      - Phantom types: guides/phantom-types.md
      - Random data: guides/random-data.md
      - Working with files: guides/files.md
    - Tutorials:
      - tutorials/index.md
      - Getting started: tutorials/getting-started.md
      - Scripting with Cara: tutorials/scripting.md
theme:
  name: material
  icon:
    repo: fontawesome/brands/github
    logo: material/weather-sunset
  favicon: assets/images/favicon.png
  palette:
    primary: deep orange
  font:
    text: Rubik
    code: JetBrains Mono
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.indexes
    - navigation.top
    - navigation.expand
    - search.highlight
    - search.suggest
    - content.code.annotate
    - content.tooltips
markdown_extensions:
  - admonition
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      guess_lang: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
      clickable_checkbox: false
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/cara-lang/compiler
      name: Compiler
    - icon: fontawesome/brands/github
      link: https://github.com/cara-lang/website
      name: Website
extra_css:
  - stylesheets/extra.css
plugins:
  - search
  - typeset
  - privacy:
      external_links_attr_map:
        target: _blank
      external_links_noopener: true
  - minify:
      minify_html: true
# TODO try links in frontmatter for an automatic "Further reading" section
# ------- https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#adding-related-links
# TODO try document contributors
# ------- https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#document-contributors
# TODO try card grids
# ------- https://squidfunk.github.io/mkdocs-material/reference/grids/#using-card-grids
# TODO try the blog? (*gulp*)
# ------- https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/