SeaCogs/mkdocs.yml

site_name: SeaCogs Documentation
site_url: !ENV [SITE_URL, 'https://seacogs.coastalcommits.com']
repo_name: CoastalCommits
repo_url: https://coastalcommits.com/cswimr/SeaCogs
edit_uri: !ENV [EDIT_URI, 'src/branch/main/.docs']
copyright: Copyright &copy; 2023-2024, cswimr
docs_dir: .docs

site_author: cswimr
site_description: Documentation for my Red-DiscordBot Cogs.

nav:
  - Home: index.md
  - Aurora:
    - aurora/index.md
    - Moderation Commands: aurora/moderation-commands.md
    - Case Commands: aurora/case-commands.md
    - Configuration: aurora/configuration.md
  - Bible: bible.md
  - Backup: backup.md
  - EmojiInfo: emojiinfo.md
  - Nerdify: nerdify.md
  - Pterodactyl:
    - pterodactyl/index.md
    - Installing Red: pterodactyl/installing-red.md
    - Getting Started: pterodactyl/getting-started.md
    - Configuration: pterodactyl/configuration.md
    - Regex Examples: pterodactyl/regex.md

plugins:
  - git-authors
  - search
  - social
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [aurora, nerdify]
          options:
            docstring_options:
              ignore_imit_summary: true
            summary: true
            show_root_toc_entry: true
            show_root_heading: true
            filters:
              - "!^___"

markdown_extensions:
  - abbr
  - attr_list
  - md_in_html
  - tables
  - pymdownx.blocks.details
  - pymdownx.blocks.admonition
  - pymdownx.saneheaders
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

theme:
  name: material
  palette:
    - media: '(prefers-color-scheme: light)'
      scheme: default
      primary: white
      accent: light blue
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode

    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      primary: black
      accent: light blue
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to light mode
  features:
    - announce.dismiss
    - content.code.annotate
    - content.code.copy
    - navigation.instant
    - navigation.instant.progress
    - navigation.tabs
    - navigation.tracking
    - navigation.top
    - navigation.sections
    - navigation.indexes
    - search.suggest
    - search.highlight
    - search.share
    - toc.follow
  logo: img/logo.png
  favicon: img/logo.png
  icon:
    repo: simple/forgejo

watch:
  - ./aurora
  - ./backup
  - ./bible
  - ./nerdify
  - ./pterodactyl
  - ./emojiinfo
  - ./antipolls
feat(docs): added documentation using mkdocs and readthedocs 2024-01-04 17:23:11 -05:00			`site_name: SeaCogs Documentation`
feat(docs): updated docs with the version of documentation on the updatechecker branch 2024-01-16 12:45:24 -05:00			`site_url: !ENV [SITE_URL, 'https://seacogs.coastalcommits.com']`
feat(docs): added documentation using mkdocs and readthedocs 2024-01-04 17:23:11 -05:00			`repo_name: CoastalCommits`
fix(repo): update all instances of SeaswimmerTheFsh to cswimr 2024-08-27 14:25:14 -04:00			`repo_url: https://coastalcommits.com/cswimr/SeaCogs`
feat(docs): updated docs with the version of documentation on the updatechecker branch 2024-01-16 12:45:24 -05:00			`edit_uri: !ENV [EDIT_URI, 'src/branch/main/.docs']`
fix(repo): update all instances of SeaswimmerTheFsh to cswimr 2024-08-27 14:25:14 -04:00			`copyright: Copyright © 2023-2024, cswimr`
feat(docs): added documentation using mkdocs and readthedocs 2024-01-04 17:23:11 -05:00			`docs_dir: .docs`

fix(repo): update all instances of SeaswimmerTheFsh to cswimr 2024-08-27 14:25:14 -04:00			`site_author: cswimr`
feat(docs): added documentation using mkdocs and readthedocs 2024-01-04 17:23:11 -05:00			`site_description: Documentation for my Red-DiscordBot Cogs.`

			`nav:`
			`- Home: index.md`
feat(docs): bunch of updates and changes and crap 2024-01-04 21:57:54 -05:00			`- Aurora:`
feat(docs): updated docs with the version of documentation on the updatechecker branch 2024-01-16 12:45:24 -05:00			`- aurora/index.md`
feat(docs): bunch of updates and changes and crap 2024-01-04 21:57:54 -05:00			`- Moderation Commands: aurora/moderation-commands.md`
			`- Case Commands: aurora/case-commands.md`
			`- Configuration: aurora/configuration.md`
fix(docs): few documentation fixes 2024-02-01 17:19:23 -05:00			`- Bible: bible.md`
feat(docs): added Backup documentation 2024-01-31 12:31:37 -05:00			`- Backup: backup.md`
docs(emojiinfo): made docs visible on the navigation header 2024-05-08 16:10:34 -04:00			`- EmojiInfo: emojiinfo.md`
feat(docs): adding documentation for some cogs 2024-01-04 18:03:34 -05:00			`- Nerdify: nerdify.md`
docs(pterodactyl): added docs pages 2024-02-29 22:11:37 -05:00			`- Pterodactyl:`
			`- pterodactyl/index.md`
docs(pterodactyl): added a guide on installing Red on Pterodactyl 2024-03-04 15:26:25 -05:00			`- Installing Red: pterodactyl/installing-red.md`
docs(pterodactyl): flushed out the docs more 2024-03-01 23:35:12 -05:00			`- Getting Started: pterodactyl/getting-started.md`
			`- Configuration: pterodactyl/configuration.md`
docs(pterodactyl): added regex examples page 2024-03-02 15:11:14 -05:00			`- Regex Examples: pterodactyl/regex.md`
feat(docs): added documentation using mkdocs and readthedocs 2024-01-04 17:23:11 -05:00
			`plugins:`
			`- git-authors`
			`- search`
fix(repo): update all instances of SeaswimmerTheFsh to cswimr 2024-08-27 14:25:14 -04:00			`- social`
feat(docs): added documentation using mkdocs and readthedocs 2024-01-04 17:23:11 -05:00			`- git-revision-date-localized:`
			`enable_creation_date: true`
			`type: timeago`
			`- mkdocstrings:`
			`default_handler: python`
			`handlers:`
			`python:`
			`paths: [aurora, nerdify]`
			`options:`
			`docstring_options:`
			`ignore_imit_summary: true`
			`summary: true`
feat(docs): bunch of updates and changes and crap 2024-01-04 21:57:54 -05:00			`show_root_toc_entry: true`
			`show_root_heading: true`
feat(docs): added documentation using mkdocs and readthedocs 2024-01-04 17:23:11 -05:00			`filters:`
			`- "!^___"`

			`markdown_extensions:`
			`- abbr`
			`- attr_list`
			`- md_in_html`
			`- tables`
			`- pymdownx.blocks.details`
			`- pymdownx.blocks.admonition`
			`- pymdownx.saneheaders`
			`- pymdownx.magiclink`
			`- pymdownx.mark`
			`- pymdownx.inlinehilite`
			`- pymdownx.snippets`
			`- pymdownx.superfences`
			`- pymdownx.highlight:`
			`anchor_linenums: true`
			`line_spans: __span`
			`pygments_lang_class: true`
			`- pymdownx.emoji:`
			`emoji_index: !!python/name:material.extensions.emoji.twemoji`
			`emoji_generator: !!python/name:material.extensions.emoji.to_svg`

			`theme:`
			`name: material`
			`palette:`
feat(docs): updated docs with the version of documentation on the updatechecker branch 2024-01-16 12:45:24 -05:00			`- media: '(prefers-color-scheme: light)'`
			`scheme: default`
misc(docs): changed header colors 2024-02-10 18:47:36 -05:00			`primary: white`
feat(docs): updated docs with the version of documentation on the updatechecker branch 2024-01-16 12:45:24 -05:00			`accent: light blue`
			`toggle:`
			`icon: material/toggle-switch`
			`name: Switch to dark mode`

			`- media: '(prefers-color-scheme: dark)'`
			`scheme: slate`
misc(docs): changed header colors 2024-02-10 18:47:36 -05:00			`primary: black`
feat(docs): updated docs with the version of documentation on the updatechecker branch 2024-01-16 12:45:24 -05:00			`accent: light blue`
			`toggle:`
			`icon: material/toggle-switch-off-outline`
			`name: Switch to light mode`
feat(docs): added documentation using mkdocs and readthedocs 2024-01-04 17:23:11 -05:00			`features:`
feat(docs): updated docs with the version of documentation on the updatechecker branch 2024-01-16 12:45:24 -05:00			`- announce.dismiss`
feat(docs): added documentation using mkdocs and readthedocs 2024-01-04 17:23:11 -05:00			`- content.code.annotate`
			`- content.code.copy`
			`- navigation.instant`
feat(docs): updated docs with the version of documentation on the updatechecker branch 2024-01-16 12:45:24 -05:00			`- navigation.instant.progress`
feat(docs): bunch of updates and changes and crap 2024-01-04 21:57:54 -05:00			`- navigation.tabs`
feat(docs): updated docs with the version of documentation on the updatechecker branch 2024-01-16 12:45:24 -05:00			`- navigation.tracking`
			`- navigation.top`
			`- navigation.sections`
			`- navigation.indexes`
feat(docs): added documentation using mkdocs and readthedocs 2024-01-04 17:23:11 -05:00			`- search.suggest`
			`- search.highlight`
			`- search.share`
feat(docs): updated docs with the version of documentation on the updatechecker branch 2024-01-16 12:45:24 -05:00			`- toc.follow`
feat(docs): added documentation using mkdocs and readthedocs 2024-01-04 17:23:11 -05:00			`logo: img/logo.png`
			`favicon: img/logo.png`
feat(docs): updated docs with the version of documentation on the updatechecker branch 2024-01-16 12:45:24 -05:00			`icon:`
			`repo: simple/forgejo`
feat(docs): added documentation using mkdocs and readthedocs 2024-01-04 17:23:11 -05:00
			`watch:`
			`- ./aurora`
feat(docs): added Backup documentation 2024-01-31 12:31:37 -05:00			`- ./backup`
fix(docs): few documentation fixes 2024-02-01 17:19:23 -05:00			`- ./bible`
feat(docs): added documentation using mkdocs and readthedocs 2024-01-04 17:23:11 -05:00			`- ./nerdify`
fix(pterodactyl): remove useless config key 2024-03-01 01:17:48 -05:00			`- ./pterodactyl`
fix(repo): update all instances of SeaswimmerTheFsh to cswimr 2024-08-27 14:25:14 -04:00			`- ./emojiinfo`
			`- ./antipolls`