Skip to content

Commit

Permalink
chore(extensions.yml): update markdown extensions in extensions.yml
Browse files Browse the repository at this point in the history 
chore(mkdocs.yml): update markdown extensions in mkdocs.yml
The markdown extensions in both `extensions.yml` and `mkdocs.yml` have been updated. The changes include:
- Adding the `abbr`, `admonition`, `attr_list`, `def_list`, `footnotes`, and `md_in_html` extensions to the list of markdown extensions.
- Adding the `pymdownx.snippets` and `pymdownx.tilde` extensions to the list of markdown extensions in `mkdocs.yml`.
- Removing the `permalink` option from the `toc` extension in both files.
- Removing the `pymdownx.arithmatex`, `pymdownx.betterem`, `pymdownx.caret`, `pymdownx.critic`, `pymdownx.details`, `pymdownx.highlight`, `pymdownx.tasklist` extensions from `mkdocs.yml`.
- Updating the configuration of the `pymdownx.emoji` extension in both files to use the `material.extensions.emoji.twemoji` index and `material.extensions.emoji.to_svg` generator.
- Adding a custom icon set for the `pymdownx.emoji` extension in `extensions.yml`.
- Adding a custom fence for the `mermaid` code block in the `pymdownx.superfences` extension in both files.
- Updating the `pymdownx.tabbed` extension in `mkdocs.yml` to use the `pymdownx.slugs.slugify` slugify function.
- Removing the `pymdownx.tasklist` extension from `mkdocs.yml`.
- Updating the `pymdownx.magiclink` extension in both files to use the `robinmordasiewicz/devops-toolkit` repository.
- Adding the `pymdownx.inlinehilite` and `pymdownx.keys` extensions to the list of markdown extensions in both files.
- Adding the `pymdownx.mark` and `pymdownx.smartsymbols` extensions to the list of markdown extensions in both files.
- Removing the commented out `pymdownx.snippets` extension configuration in `extensions.yml`.
- Removing the commented out `pymdownx.snippets` extension configuration in `mkdocs.yml`.
- Removing the commented out `pymdownx.tasklist` extension configuration in `mkdocs.yml`.
- Removing the commented out `pymdownx.tilde` extension configuration in `mkdocs.yml`.
- Updating the `pymdownx.superfences` extension in both files to preserve tabs in code blocks.
- Updating the `pymdownx.tabbed` extension in `mkdocs.yml` to use an alternate style and combine header slugs.
- Removing the `pymdownx.tasklist` extension from `mkdocs.yml`.
- Removing the `pymdownx.tilde` extension from `mkdocs.yml`.
- Updating the `pymdownx.magiclink` extension in both files to normalize issue symbols and use shorthand repository URLs.
- Updating the `pymdownx.superfences` extension in both files to use the `pymdownx.superfences.fence_code_format` format for the `mermaid` code block.
- Removing the `pymdownx.tasklist` extension from `mkdocs.yml`.
- Removing the `pymdownx.tilde` extension from `mkdocs.yml`.
- Updating the `pymdownx.tabbed` extension in `mkdocs.yml` to use the `pymdownx.slugs.slugify` slugify function.
- Removing the `pymdownx.tasklist` extension from `mkdocs.yml`.
- Removing the `pymdownx.tilde` extension from `mkdocs.yml`.
- Updating the `pymdownx.magiclink` extension in both files to normalize issue symbols and use shorthand repository URLs.
- Updating the `pymdownx.superfences` extension in both files to preserve tabs in code blocks.
- Adding a custom fence for the `mermaid` code block in the `pymdownx.superfences` extension in both files.
- Updating the `pymdownx.inlinehilite` and `pymdownx.keys` extensions in both files.
- Updating the `pymdownx.mark` and `pymdownx.smartsymbols` extensions in both files.
- Removing the commented out `pymdownx.snippets` extension configuration in `extensions.yml`.
- Removing the commented out `pymdownx.snippets` extension configuration in `mkdocs.yml`.
- Removing the commented out `pymdownx.tasklist` extension configuration in `mkdocs.yml`.
- Removing the commented out `pymdownx.tilde` extension configuration in `mkdocs.yml`.

feat(mkdocs.yml.working): add initial configuration for MkDocs site
The commit adds the initial configuration for the MkDocs site. It includes settings for the site name, description, URLs, repository, edit URI, and extra features such as annotations and social media links. It also configures the theme, including the logo, favicon, and various features and color schemes. Additionally, it sets up markdown extensions, plugins, and navigation structure for the site.
  • Loading branch information
@robinmordasiewicz
robinmordasiewicz committed Nov 25, 2023
1 parent fefec4b commit 7da5d2c
Show file tree
Hide file tree
Showing 3 changed files with 245 additions and 30 deletions.
50 changes: 50 additions & 0 deletions extensions.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
options:
custom_icons:
- overrides/.icons
- toc:
toc_depth: "1-1"
permalink: false
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
normalize_issue_symbols: true
repo_url_shorthand: true
user: robinmordasiewicz
repo: devops-toolkit
- pymdownx.mark
- pymdownx.smartsymbols
# - pymdownx.snippets:
# auto_append:
# - includes/mkdocs.md
- pymdownx.superfences:
preserve_tabs: true
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
combine_header_slug: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
44 changes: 14 additions & 30 deletions mkdocs.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,36 +88,29 @@ theme:
code: Roboto Mono

markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
options:
custom_icons:
- overrides/.icons
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- toc:
toc_depth: "1-1"
permalink: false
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_generator: !!python/name:material.extensions.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tilde
- pymdownx.keys
- pymdownx.magiclink:
normalize_issue_symbols: true
Expand All @@ -126,9 +119,6 @@ markdown_extensions:
repo: devops-toolkit
- pymdownx.mark
- pymdownx.smartsymbols
# - pymdownx.snippets:
# auto_append:
# - includes/mkdocs.md
- pymdownx.superfences:
preserve_tabs: true
custom_fences:
Expand All @@ -140,12 +130,6 @@ markdown_extensions:
combine_header_slug: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
- pymdownx.tasklist:
custom_checkbox: true
clickable_checkbox: true
- pymdownx.tilde

plugins:
- glightbox
- social
Expand Down
181 changes: 181 additions & 0 deletions mkdocs.yml.working
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,181 @@
---
site_name: DevOps ToolKit
site_description: DevOps ToolKit
site_url: https://robinmordasiewicz.github.io/devops-toolkit/
repo_url: https://github.com/robinmordasiewicz/devops-toolkit/
edit_uri: edit/main/docs/
repo_name: "robinmordasiewicz/devops-toolkit"

extra:
annotate:
json: [.s2]
generator: false
social:
- icon: fortinet/fc-lib-fortinet
link: https://www.fortinet.com/blog
- icon: fortinet/fc-lib-facebook
link: https://www.facebook.com/fortinet
- icon: fortinet/fc-lib-twitter
link: https://twitter.com/fortinet
- icon: fortinet/fc-lib-youtube
link: https://www.youtube.com/channel/UCzpsl8Vm6OL7ij2Lm4G6Jcg
- icon: fortinet/fc-lib-linkedin
link: https://www.linkedin.com/company/fortinet/

validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn

extra_css: [extra.css]
extra_javascript: [extra.js]

# yamllint disable-line rule:line-length
copyright: '<div _ngcontent-ayh-c7="" class="left-col"><a _ngcontent-ayh-c7="" href="https://www.fortinet.com/corporate/about-us/about-us.html" rel="noopener noreferrer" target="_blank">Corporate</a>&nbsp;|&nbsp;<a _ngcontent-ayh-c7="" href="https://www.fortinet.com/partners/partner-program/find-a-partner.html" rel="noopener noreferrer" target="_blank">How to Buy</a>&nbsp;|&nbsp;<a _ngcontent-ayh-c7="" href="https://www.fortinet.com/products.html" rel="noopener noreferrer" target="_blank">Products</a>&nbsp;|&nbsp;<a _ngcontent-ayh-c7="" href="https://www.fortinet.com/support-and-training/support/contact.html" rel="noopener noreferrer" target="_blank">Services &amp; Support</a>&nbsp;|&nbsp;<a _ngcontent-ayh-c7="" href="https://www.fortinet.com/corporate/about-us/legal.html" rel="noopener noreferrer" target="_blank">Legal</a>&nbsp;|&nbsp;<a _ngcontent-ayh-c7="" href="https://www.fortinet.com/corporate/about-us/privacy.html" rel="noopener noreferrer" target="_blank">Privacy</a>&nbsp;|&nbsp;<a _ngcontent-ayh-c7="" href="https://www.fortinet.com/corporate/about-us/legal.html" rel="noopener noreferrer" target="_blank">Terms of Use</a></div>'

theme:
name: material
custom_dir: docs/overrides
logo: logo.svg
favicon: favicon.ico
include_sidebar: false
icon:
repo: fontawesome/brands/github
features:
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.code.select
- content.tabs.link
- content.tooltips
- header.autohide
- navigation.footer
- navigation.indexes
- navigation.instant
- navigation.instant.prefetch
- navigation.instant.progress
- navigation.path
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
palette:
- media: "(prefers-color-scheme: light)"
primary: black
accent: grey
scheme: default
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
primary: grey
accent: black
scheme: slate
toggle:
icon: material/toggle-switch

markdown_extensions:
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
options:
custom_icons:
- overrides/.icons
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- toc:
toc_depth: "1-1"
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tilde
- pymdownx.keys
- pymdownx.magiclink:
normalize_issue_symbols: true
repo_url_shorthand: true
user: robinmordasiewicz
repo: devops-toolkit
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.details
- pymdownx.caret
- pymdownx.critic
- pymdownx.tabbed:
alternate_style: true
combine_header_slug: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.tasklist:
custom_checkbox: true
clickable_checkbox: true

plugins:
- glightbox
- social
- blog
- search:
separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'

nav:
- "Home": "index.md"
- "Concepts":
- devops.md
- digitial-journey.md
- challenge.md
- source-of-truth.md
- gitops.md
- gitflow.md
- secure-cloud-blueprint.md
- "Accounts": "accounts.md"
- "Platforms":
- "Source Control":
- github-create-repo.md
- github-profile.md
- github-fork-repo.md
- "Cloud Provider":
- azure-cloud-shell.md
- azure-install-terraform.md
- azure-az-login.md
- "Deploy Infrastructure":
- azure-subscription.md
- github-clone-repo.md
- terraform-environment.md
- terraform-deploy.md
- "Publish Changes":
- github-branch.md
- opencommit-conventional.md
- opencommit-install.md
- azure-install-gh.md
- github-commit.md
- github-push.md
- github-pull-request.md
- github-workflow-linter.md
- github-merge.md
- fortinet-fortidevsec.md
- "CI/CD":
- github-personal-access-token.md
- github-secrets.md
- azure-oidc.md
- github-workflows.md
- fortimanager.md
- fortimanager-ztp.md
- github-copilot-install.md
- links.md

0 comments on commit 7da5d2c

Please sign in to comment.