diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 01d3c616f4..80a54c9334 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -23,7 +23,7 @@ jobs: - run: mkdocs build deploy: - if: github.event_name == 'push' && contains(fromJson('["refs/heads/master", "refs/heads/main", "refs/heads/mkdocs"]'), github.ref) + if: github.event_name == 'push' && contains(fromJson('["refs/heads/master", "refs/heads/main"]'), github.ref) needs: build name: Deploy docs runs-on: ubuntu-latest diff --git a/docs/assets/favicon.ico b/docs/assets/favicon.ico new file mode 100644 index 0000000000..a7deda848f Binary files /dev/null and b/docs/assets/favicon.ico differ diff --git a/docs/assets/icon.svg b/docs/assets/icon.svg new file mode 100644 index 0000000000..1d60dcce7c --- /dev/null +++ b/docs/assets/icon.svg @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Asset 1 + + + + + + + + + + + + + + + + + diff --git a/docs/javascripts/tablesort.js b/docs/javascripts/tablesort.js new file mode 100644 index 0000000000..4014300f8e --- /dev/null +++ b/docs/javascripts/tablesort.js @@ -0,0 +1,6 @@ +document$.subscribe(function () { + var tables = document.querySelectorAll("article table:not([class])"); + tables.forEach(function (table) { + new Tablesort(table); + }); +}); diff --git a/docs/requirements.txt b/docs/requirements.txt index d4aa146bd9..16500f1ebc 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,5 @@ mkdocs-awesome-pages-plugin==2.9.1 +mkdocs-git-revision-date-localized-plugin==1.2.0 mkdocs-material==9.1.21 mkdocs-minify-plugin==0.7.0 mkdocs-redirects==1.2.1 diff --git a/mkdocs.yml b/mkdocs.yml index 536380af3c..a439209772 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,48 +5,84 @@ site_description: Welcome to the home of the LinuxServer.io documentation! repo_name: linuxserver/docker-documentation repo_url: https://github.com/linuxserver/docker-documentation -edit_uri: "" -copyright: Copyright © 2022 LinuxServer.io +copyright: Copyright © 2023 LinuxServer.io theme: name: material - language: en features: + # - content.action.edit + - content.code.copy + - navigation.footer - navigation.instant + - navigation.prune + - navigation.top + - navigation.tracking + - search.highlight + - search.share + - search.suggest + - toc.follow palette: - media: "(prefers-color-scheme: light)" scheme: default primary: purple accent: indigo toggle: - icon: material/toggle-switch-off-outline + icon: material/brightness-7 name: Switch to dark mode - media: "(prefers-color-scheme: dark)" scheme: slate primary: purple accent: indigo toggle: - icon: material/toggle-switch + icon: material/brightness-4 name: Switch to light mode - favicon: https://gblobscdn.gitbook.com/spaces%2F-LWuIse8qFJj2MqDi90T%2Favatar-1590244439115.png?alt=media - logo: https://gblobscdn.gitbook.com/spaces%2F-LWuIse8qFJj2MqDi90T%2Favatar-1590244439115.png?alt=media - -markdown_extensions: - - pymdownx.extra - - pymdownx.snippets - -plugins: - - search - - awesome-pages - - minify: - minify_html: true + favicon: assets/favicon.ico + logo: assets/icon.svg extra: social: - - icon: fontawesome/brands/square-github + - icon: fontawesome/solid/otter + link: https://linuxserver.io + - icon: fontawesome/brands/discord + link: https://discord.gg/YWrKVTn + - icon: fontawesome/brands/discourse + link: https://discourse.linuxserver.io + - icon: fontawesome/brands/github link: https://github.com/linuxserver - - icon: fontawesome/brands/square-gitlab + - icon: fontawesome/brands/gitlab link: https://gitlab.com/linuxserver.io - - icon: fontawesome/brands/square-twitter + - icon: fontawesome/brands/facebook + link: https://www.facebook.com/linuxserver.io + - icon: fontawesome/brands/mastodon + link: https://mastodon.linuxserver.io/@linuxserver + - icon: fontawesome/brands/twitter link: https://twitter.com/linuxserverio + +extra_javascript: + - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js + - javascripts/tablesort.js + +markdown_extensions: + - admonition + - pymdownx.details + - pymdownx.escapeall + - pymdownx.extra + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.superfences + - tables + - toc: + permalink: true + +plugins: + - awesome-pages + # - git-revision-date-localized: + # enable_creation_date: true + - minify: + minify_html: true + - search