docs/mkdocs.yml at master · illumos/docs · 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
site_name: 'illumos'
repo_name: 'illumos/docs'
repo_url: 'https://github.com/illumos/docs'

nav:
  - 'Home': 'index.md'
  - 'About':
    - 'What is illumos?': 'about/index.md'
    - 'Who uses illumos?': 'about/who.md'
    - 'Features': 'about/features.md'
    - 'Distributions': 'about/distro.md'
    - 'Leadership': 'about/leadership.md'
    - 'FAQ': 'about/faq.md'
    - 'Logo': 'about/logo.md'
  - 'History':
    - 'Overview': 'about/history.md'
    - 'Announcement': 'about/announcement.md'
  - 'User Guide':
    - 'Getting Started': 'user-guide/index.md'
    - 'Bug Reporting': 'user-guide/bugs.md'
    - 'Security': 'security/index.md'
    - 'Debugging':
      - 'Systems': 'user-guide/debug-systems.md'
      - 'Applications': 'user-guide/debug-apps.md'
  - 'Development':
    - 'Building illumos': 'developers/build.md'
    - 'Flag Days': 'developers/flagdays.md'
  - 'Contributing':
    - 'Overview': 'contributing/index.md'
    - 'Code Review (Gerrit)': 'contributing/gerrit.md'
    - 'On Quality': 'contributing/quality.md'
    - 'Quality Death Spiral': 'contributing/qds.md'
    - 'Documentation': 'contributing/docs.md'
  - 'Community':
    - 'Overview': 'community/index.md'
    - 'Code of Conduct': 'community/conduct.md'
    - 'Mailing Lists': 'community/lists.md'
    - 'Events': 'community/events.md'
    - 'Videos': 'community/videos.md'

theme:
  name: material
  custom_dir: overrides
  language: en
  logo: 'assets/images/illumos.svg'
  palette:
    primary: "#326ca6"
    accent: "#fc4524"
  font: false
  include_search_page: false
  search_index_only: true

extra_css:
  - stylesheets/illumos.css

extra:
  social:
    - icon: 'fontawesome/brands/github-alt'
      link: 'https://github.com/illumos'


markdown_extensions:
  - admonition
  - codehilite:
      guess_lang: false
  - toc:
      permalink: true
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:pymdownx.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - markdown_include.include:
      base_path: docs