docker-mailserver/docs/mkdocs.yml

site_name: 'Docker Mailserver'
site_description: 'A fullstack but simple mail server (SMTP, IMAP, LDAP, Antispam, Antivirus, etc.) using Docker.'
site_author: 'docker-mailserver (Github Organization)'
repo_name: 'docker-mailserver'
repo_url: 'https://github.com/docker-mailserver/docker-mailserver'
copyright: '<p>&copy <a href="https://github.com/docker-mailserver"><em>Docker Mailserver Organization</em></a><br/><span>This project is licensed under the MIT license.</span></p>'

docs_dir: 'content/'
site_url: 'https://docker-mailserver.github.io/docker-mailserver'
theme:
  name: 'material'
  favicon: assets/logo/favicon-32x32.png
  logo: assets/logo/dmo-logo-white.svg
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.tabs
    - navigation.expand

markdown_extensions:
  - toc:
      permalink: ⚓︎
  - abbr
  - attr_list
  - admonition
  - pymdownx.highlight:
      extend_pygments_lang:
        - name: yml
          lang: yaml
        - name: cf
          lang: cfg
        - name: conf
          lang: cfg
  - pymdownx.superfences
  - pymdownx.magiclink
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
docs(config): Add initial `mkdocs.yml` config 2021-02-28 11:53:15 +00:00			`site_name: 'Docker Mailserver'`
			`site_description: 'A fullstack but simple mail server (SMTP, IMAP, LDAP, Antispam, Antivirus, etc.) using Docker.'`
			`site_author: 'docker-mailserver (Github Organization)'`
			`repo_name: 'docker-mailserver'`
			`repo_url: 'https://github.com/docker-mailserver/docker-mailserver'`
			`copyright: '<p>&copy <a href="https://github.com/docker-mailserver"><em>Docker Mailserver Organization</em></a><br/><span>This project is licensed under the MIT license.</span></p>'`

			`docs_dir: 'content/'`
docs(assets): Add SVG logo and ICO favicon. Adds the SVG logo I created (composited rather) in mid-feb in one of my PRs that went slightly off-topic about migrating docs from Github Wiki. Enables the logo and favicon in `mkdocs.yml`. SVG sources for both full colour and simplified monochromatic are included along with PNG images for use anywhere else, such as the organization logo. The two SVG of the same names from `src` dir, are used by the docs and have been processed through SVGOMG, an SVG file size optimizer. Any future modifications should use the source files. 2021-03-04 12:39:26 +00:00			`site_url: 'https://docker-mailserver.github.io/docker-mailserver'`
docs(config): Add initial `mkdocs.yml` config 2021-02-28 11:53:15 +00:00			`theme:`
			`name: 'material'`
docs(assets): Add SVG logo and ICO favicon. Adds the SVG logo I created (composited rather) in mid-feb in one of my PRs that went slightly off-topic about migrating docs from Github Wiki. Enables the logo and favicon in `mkdocs.yml`. SVG sources for both full colour and simplified monochromatic are included along with PNG images for use anywhere else, such as the organization logo. The two SVG of the same names from `src` dir, are used by the docs and have been processed through SVGOMG, an SVG file size optimizer. Any future modifications should use the source files. 2021-03-04 12:39:26 +00:00			`favicon: assets/logo/favicon-32x32.png`
			`logo: assets/logo/dmo-logo-white.svg`
docs(config): Add initial `mkdocs.yml` config 2021-02-28 11:53:15 +00:00			`icon:`
			`repo: fontawesome/brands/github`
			`features:`
			`- navigation.tabs`
			`- navigation.expand`

			`markdown_extensions:`
			`- toc:`
			`permalink: ⚓︎`
			`- abbr`
			`- attr_list`
			`- admonition`
			`- pymdownx.highlight:`
			`extend_pygments_lang:`
			`- name: yml`
			`lang: yaml`
			`- name: cf`
			`lang: cfg`
			`- name: conf`
			`lang: cfg`
			`- pymdownx.superfences`
			`- pymdownx.magiclink`
			`- pymdownx.emoji:`
			`emoji_index: !!python/name:materialx.emoji.twemoji`
			`emoji_generator: !!python/name:materialx.emoji.to_svg`