From d592cd5d77452363188e69aeaa94e57417f48135 Mon Sep 17 00:00:00 2001 From: Jef LeCompte Date: Tue, 15 Dec 2020 00:23:04 -0500 Subject: [PATCH] chore: update template, typos in docs (#1386) --- .github/ISSUE_TEMPLATE/bug-report.md | 2 +- docs/overrides/main.html | 30 ++++++++++++++++++++++++++++ docs/reference/notification.md | 2 +- mkdocs.yml | 4 +++- 4 files changed, 35 insertions(+), 3 deletions(-) create mode 100644 docs/overrides/main.html diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 7fce4f1..3306bd7 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -3,7 +3,7 @@ name: "\U0001F41B Bug report" about: Report a bug for this project title: '' labels: '' -assignees: jef +assignees: '' --- diff --git a/docs/overrides/main.html b/docs/overrides/main.html new file mode 100644 index 0000000..fc787d6 --- /dev/null +++ b/docs/overrides/main.html @@ -0,0 +1,30 @@ +{% extends "base.html" %} + +{% block extrahead %} + {% set title = config.site_name %} + {% if page and page.meta and page.meta.title %} + {% set title = title ~ " - " ~ page.meta.title %} + {% elif page and page.title and not page.is_homepage %} + {% set title = title ~ " - " ~ page.title | striptags %} + {% endif %} + + {% set image = config.site_url ~ 'assets/images/banner.png' %} + + + + + + + + + + + + + + + + + + +{% endblock %} diff --git a/docs/reference/notification.md b/docs/reference/notification.md index 0852473..5050064 100644 --- a/docs/reference/notification.md +++ b/docs/reference/notification.md @@ -36,7 +36,7 @@ You can test your notification configuration by running `npm run test:notificati | `DISCORD_WEB_HOOK` | Discord Web Hook URL. Can be comma separated. Use whole webhook URL | ???+ note - All ground can be comma separated. `DISCORD_NOTIFY_GROUP` is always used if set. + All groups can be comma separated. `DISCORD_NOTIFY_GROUP` is always used if set. - If you're using a role, please use `<@&2834729847239842>` - If you're using a user, please use `<@2834729847239842>` diff --git a/mkdocs.yml b/mkdocs.yml index a17e4ed..d9b58c5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -13,12 +13,13 @@ copyright: Copyright © 2016 - 2020 Jef LeCompte # Configuration theme: + custom_dir: docs/overrides favicon: https://raw.githubusercontent.com/jef/streetmerchant/main/docs/assets/images/streetmerchant-logo.png features: - search.suggest font: text: Noto Sans - code: JetBrains Mono + code: Space Mono icon: repo: octicons/octoface-24 logo: assets/images/streetmerchant-logo.png @@ -83,6 +84,7 @@ nav: - Application: reference/application.md - Filter: reference/filter.md - Notification: reference/notification.md + - Proxy: reference/proxy.md - Help: - General: help/general.md - Troubleshoot: help/troubleshoot.md