MkDocs

1 week ago 4

Undid revision 1285995232 by Samuel Marks (talk) (in preparation for my next exit)

← Previous revision Revision as of 07:31, 5 July 2025
Line 54: Line 54:
Many companies use MkDocs with the Material theme to deploy their documentation, including [[Atlassian]],<ref>{{Cite web |title=Atlassian DC Helm Charts |url=https://atlassian.github.io/data-center-helm-charts/ |access-date=2023-12-10 |website=atlassian.github.io}}</ref> [[Google]],<ref>{{Cite web |title=Accompanist |url=https://google.github.io/accompanist/ |access-date=2023-12-10 |website=google.github.io}}</ref> [[Microsoft]],<ref>{{Cite web |title=Code With Engineering Playbook |url=https://microsoft.github.io/code-with-engineering-playbook/ |access-date=2023-12-10 |website=microsoft.github.io}}</ref> and [[Red Hat]].<ref>{{Cite web |title=home - Ansible Lint Documentation |url=https://ansible-lint.readthedocs.io/ |access-date=2023-12-10 |website=ansible-lint.readthedocs.io |language=en}}</ref> It is also a popular choice among open source projects, such as [[Electron (software framework)|Electron]],<ref>{{Cite web |title=electron-builder |url=https://www.electron.build/ |access-date=2023-12-10 |website=www.electron.build}}</ref> [[Kubernetes]],<ref>{{Cite web |title=Welcome - kOps - Kubernetes Operations |url=https://kops.sigs.k8s.io/ |access-date=2023-12-10 |website=kops.sigs.k8s.io}}</ref> and [[WebKit]].<ref>{{Cite web |title=WebKit Documentation |url=https://docs.webkit.org/ |access-date=2023-12-10 |website=docs.webkit.org}}</ref>
Many companies use MkDocs with the Material theme to deploy their documentation, including [[Atlassian]],<ref>{{Cite web |title=Atlassian DC Helm Charts |url=https://atlassian.github.io/data-center-helm-charts/ |access-date=2023-12-10 |website=atlassian.github.io}}</ref> [[Google]],<ref>{{Cite web |title=Accompanist |url=https://google.github.io/accompanist/ |access-date=2023-12-10 |website=google.github.io}}</ref> [[Microsoft]],<ref>{{Cite web |title=Code With Engineering Playbook |url=https://microsoft.github.io/code-with-engineering-playbook/ |access-date=2023-12-10 |website=microsoft.github.io}}</ref> and [[Red Hat]].<ref>{{Cite web |title=home - Ansible Lint Documentation |url=https://ansible-lint.readthedocs.io/ |access-date=2023-12-10 |website=ansible-lint.readthedocs.io |language=en}}</ref> It is also a popular choice among open source projects, such as [[Electron (software framework)|Electron]],<ref>{{Cite web |title=electron-builder |url=https://www.electron.build/ |access-date=2023-12-10 |website=www.electron.build}}</ref> [[Kubernetes]],<ref>{{Cite web |title=Welcome - kOps - Kubernetes Operations |url=https://kops.sigs.k8s.io/ |access-date=2023-12-10 |website=kops.sigs.k8s.io}}</ref> and [[WebKit]].<ref>{{Cite web |title=WebKit Documentation |url=https://docs.webkit.org/ |access-date=2023-12-10 |website=docs.webkit.org}}</ref>


A major benefit of MkDocs verses other static site generators is that all the files you edit for content are pure markdown files. In contrast, jekyll, a much more popular generator due to integration/branding with github, uses yaml at the top of every markdown page that may be daunting or annoying for writers and also cannot be interpreted by many standard markdown generators, such as medium, github.com, visual studio code extensions, etc.
A major benefit of MkDocs verses other static site generators is that all the files you edit for content are pure markdown files. In contrast, jekyll, a much more popular generator due to integration/branding with github, uses yaml at the top of every markdown page that may be daunting or annoying for writers and also cannot be interpreted by many standard markdown generators, such as medium, visual studio code extensions, etc.


== See also ==
== See also ==
Open Full Post