From 9adc5e7ce73f93f4bea2ab335f103f39cb6c4571 Mon Sep 17 00:00:00 2001 From: Kailash Nadh Date: Sat, 27 Jan 2024 17:38:28 +0530 Subject: [PATCH] Refactor navigation and styling in docs. Thanks @candidexmedia. Closes #1679. --- docs/docs/content/installation.md | 31 +++++++++---------- docs/docs/content/static/style.css | 15 ++++++++-- docs/docs/mkdocs.yml | 48 ++++++++++++++++-------------- 3 files changed, 54 insertions(+), 40 deletions(-) diff --git a/docs/docs/content/installation.md b/docs/docs/content/installation.md index d5e31a702..812c3693e 100644 --- a/docs/docs/content/installation.md +++ b/docs/docs/content/installation.md @@ -145,24 +145,25 @@ The `master` branch with bleeding edge changes is periodically built and publish ## 3rd party hosting -One-click deploy on Raleway +Deploy on Elestio
-Deploy on PikaPod +Deploy on PikaPod
-Deploy at RepoCloud +One-click deploy on Railway
+Deploy at RepoCloud ## Tutorials -* [Informal step-by-step on how to get started with Listmonk using **Railway**](https://github.com/knadh/listmonk/issues/120#issuecomment-1421838533) -* [Step-by-step tutorial for installation and all basic functions. **Amazon EC2, SES, docker & binary**](https://gist.github.com/MaximilianKohler/e5158fcfe6de80a9069926a67afcae11) -* [Step-by-step guide on how to install and set up Listmonk on **AWS Lightsail with docker** (rameerez)](https://github.com/knadh/listmonk/issues/1208) -* [Quick setup on any cloud server using **docker and caddy**](https://github.com/samyogdhital/listmonk-caddy-reverse-proxy) -* [**Binary** install on Ubuntu 22.04 as a service](https://mumaritc.hashnode.dev/how-to-install-listmonk-using-binary-on-ubuntu-2204) -* [**Binary** install on Ubuntu 18.04 as a service (Apache & Plesk)](https://devgypsy.com/post/2020-08-18-installing-listmonk-newsletter-manager/) -* [**Binary and docker** on linux (techviewleo)](https://techviewleo.com/manage-mailing-list-and-newsletter-using-listmonk/) -* [**Binary** install on your PC](https://www.youtube.com/watch?v=fAOBqgR9Yfo). Discussions of limitations: [[1](https://github.com/knadh/listmonk/issues/862#issuecomment-1307328228)][[2](https://github.com/knadh/listmonk/issues/248#issuecomment-1320806990)]. -* [**Docker on Rocky Linux 8** (nginx, Let's Encrypt SSL)](https://wiki.crowncloud.net/?How_to_Install_Listmonk_with_Docker_on_Rocky_Linux_8) -* [**Docker** with nginx reverse proxy, certbot SSL, and Gmail SMTP](https://www.maketecheasier.com/create-own-newsletter-with-listmonk/) -* [Install Listmonk on Self-hosting with **Pre-Configured AMI Package at AWS** by Single Click](https://meetrix.io/articles/how-to-install-llama-2-on-aws-with-pre-configured-ami-package/) -* [Tutorial for deploying on **Fly.io**](https://github.com/paulrudy/listmonk-on-fly) -- Currently [not working](https://github.com/knadh/listmonk/issues/984#issuecomment-1694545255) +* [Informal step-by-step on how to get started with Listmonk using *Railway*](https://github.com/knadh/listmonk/issues/120#issuecomment-1421838533) +* [Step-by-step tutorial for installation and all basic functions. *Amazon EC2, SES, docker & binary*](https://gist.github.com/MaximilianKohler/e5158fcfe6de80a9069926a67afcae11) +* [Step-by-step guide on how to install and set up Listmonk on *AWS Lightsail with docker* (rameerez)](https://github.com/knadh/listmonk/issues/1208) +* [Quick setup on any cloud server using *docker and caddy*](https://github.com/samyogdhital/listmonk-caddy-reverse-proxy) +* [*Binary* install on Ubuntu 22.04 as a service](https://mumaritc.hashnode.dev/how-to-install-listmonk-using-binary-on-ubuntu-2204) +* [*Binary* install on Ubuntu 18.04 as a service (Apache & Plesk)](https://devgypsy.com/post/2020-08-18-installing-listmonk-newsletter-manager/) +* [*Binary and docker* on linux (techviewleo)](https://techviewleo.com/manage-mailing-list-and-newsletter-using-listmonk/) +* [*Binary* install on your PC](https://www.youtube.com/watch?v=fAOBqgR9Yfo). Discussions of limitations: [[1](https://github.com/knadh/listmonk/issues/862#issuecomment-1307328228)][[2](https://github.com/knadh/listmonk/issues/248#issuecomment-1320806990)]. +* [*Docker on Rocky Linux 8* (nginx, Let's Encrypt SSL)](https://wiki.crowncloud.net/?How_to_Install_Listmonk_with_Docker_on_Rocky_Linux_8) +* [*Docker* with nginx reverse proxy, certbot SSL, and Gmail SMTP](https://www.maketecheasier.com/create-own-newsletter-with-listmonk/) +* [Install Listmonk on Self-hosting with *Pre-Configured AMI Package at AWS* by Single Click](https://meetrix.io/articles/how-to-install-llama-2-on-aws-with-pre-configured-ami-package/) +* [Tutorial for deploying on *Fly.io*](https://github.com/paulrudy/listmonk-on-fly) -- Currently [not working](https://github.com/knadh/listmonk/issues/984#issuecomment-1694545255) diff --git a/docs/docs/content/static/style.css b/docs/docs/content/static/style.css index 9d300d745..3dc5f3f0e 100644 --- a/docs/docs/content/static/style.css +++ b/docs/docs/content/static/style.css @@ -24,11 +24,20 @@ body[data-md-color-primary="white"] padding: 10px 0; } -body[data-md-color-primary="white"] .md-nav__item--active { +.md-nav__item--section > .md-nav__link[for] { + color: #333; +} +.md-nav__item--section { + margin-bottom: 20px; +} +.md-nav__item--nested .md-nav__list { + margin-left: 20px; + border-left: 1px solid #ddd; +} + +body[data-md-color-primary="white"] a.md-nav__link--active { font-weight: 600; color: inherit; -} -body[data-md-color-primary="white"] .md-nav__item--active a { color: #0055d4; } body[data-md-color-primary="white"] .md-nav__item a:hover { diff --git a/docs/docs/mkdocs.yml b/docs/docs/mkdocs.yml index 233db6a70..2fa459f7c 100644 --- a/docs/docs/mkdocs.yml +++ b/docs/docs/mkdocs.yml @@ -15,6 +15,8 @@ theme: feature: tabs: true features: + - navigation.indexes + - navigation.sections - content.code.copy palette: @@ -34,28 +36,30 @@ markdown_extensions: extra_css: - "static/style.css" -copyright: "Copyright © 2019-2023, Kailash Nadh." +copyright: "CC BY-SA 4.0" nav: - "Introduction": index.md - - "Installation": installation.md - - "Upgrade": upgrade.md - - "Configuration": configuration.md - - "Developer setup": developer-setup.md - - "Concepts": concepts.md - - "Querying and segmenting subscribers": querying-and-segmentation.md - - "Templating": templating.md - - "Bounce processing": bounces.md - - "Messengers": "messengers.md" - - "Archives": "archives.md" - - "Internationalization": "i18n.md" - - "Integrating with external systems": external-integration.md - - "API": apis/apis.md - - "API / Subscribers": apis/subscribers.md - - "API / Lists": apis/lists.md - - "API / Import": apis/import.md - - "API / Campaigns": apis/campaigns.md - - "API / Media": apis/media.md - - "API / Templates": apis/templates.md - - "API / Transactional": apis/transactional.md - + - "Getting Started": + - "Installation": installation.md + - "Configuration": configuration.md + - "Upgrade": upgrade.md + - "Using Listmonk": + - "Concepts": concepts.md + - "Templating": templating.md + - "Querying and segmenting subscribers": querying-and-segmentation.md + - "Bounce processing": bounces.md + - "Messengers": "messengers.md" + - "Archives": "archives.md" + - "Internationalization": "i18n.md" + - "Integrating with external systems": external-integration.md + - "API": + - "Subscribers": apis/subscribers.md + - "Lists": apis/lists.md + - "Import": apis/import.md + - "Campaigns": apis/campaigns.md + - "Media": apis/media.md + - "Templates": apis/templates.md + - "Transactional": apis/transactional.md + - "Contributions": + - "Developer setup": developer-setup.md