From c3d2567d119b9f57d9398f1f9157cde58eb39069 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Thu, 23 Jul 2020 13:52:42 +0200 Subject: [PATCH] Added guide for custom icons in social links --- docs/setup/adding-social-links.md | 14 ++++++++++++++ docs/setup/changing-the-logo-and-icons.md | 4 ++-- docs/sponsorship.md | 11 ++++++++--- 3 files changed, 24 insertions(+), 5 deletions(-) diff --git a/docs/setup/adding-social-links.md b/docs/setup/adding-social-links.md index b55e31853..4cffe0c23 100644 --- a/docs/setup/adding-social-links.md +++ b/docs/setup/adding-social-links.md @@ -88,3 +88,17 @@ For each entry, the following fields are available: link: https://twitter.com/squidfunk name: squidfunk on Twitter ``` + +## Customization + +### Custom icons + +[:octicons-file-code-24: Source][2] · +:octicons-mortar-board-24: Difficulty: _moderate_ + +The social links feature uses the available [icon integration][3] of Material for +MkDocs. If you want to use custom icons, follow the guide explaining how to +add [additional icons][4]. + + [3]: changing-the-logo-and-icons.md#icons + [4]: changing-the-logo-and-icons.md#additional-icons diff --git a/docs/setup/changing-the-logo-and-icons.md b/docs/setup/changing-the-logo-and-icons.md index 8dea0bef2..2dfe1baa5 100644 --- a/docs/setup/changing-the-logo-and-icons.md +++ b/docs/setup/changing-the-logo-and-icons.md @@ -60,8 +60,8 @@ theme: [:octicons-file-code-24: Source][5] · [:octicons-workflow-24: Extension][6] The [Emoji][6] extension, which is part of [Python Markdown Extensions][7], -adds the ability to __integrate custom icons__ in the `*.svg` file format, -which are inlined into the HTML when [building your site][8]: +adds the ability to __integrate icons__ in the `*.svg` file format, which are +inlined into the HTML when [building your site][8]: ``` yaml markdown_extensions: diff --git a/docs/sponsorship.md b/docs/sponsorship.md index 1f2b64542..94b1b03a5 100644 --- a/docs/sponsorship.md +++ b/docs/sponsorship.md @@ -2,7 +2,7 @@ template: overrides/main.html --- -# :logo: :material-plus: :octicons-heart-fill-24:{: .tx-sponsor__heart } +# :logo: :material-plus: :octicons-heart-fill-24:{: .tx-heart } Material for MkDocs uses the [sponsorware][1] release strategy, which means that __new features are first exclusively released to sponsors__. Read on to learn @@ -15,13 +15,18 @@ latest features before everybody else. ## How sponsorship works -__Material for MkDocs is split into a community edition and a sponsor edition__. +__Material for MkDocs is available as a community edition and sponsor edition__. New features will first land in the _sponsor edition_, which means that sponsors will have access immediately. Every feature is tied to a funding goal in monthly subscriptions. If this funding goal is hit, the feature is merged into the _community edition_ and released to the public to be generally available. Bugs -will be fixed in the community edition and merged back into the sponsor edition. +will be fixed in the community edition and merged back into the sponsor edition: + +- :material-bug-check: Bugfixes: _community edition_ :material-arrow-right: + _sponsor edition_ +- :material-new-box: Features: _community edition_ :material-arrow-left: + _sponsor edition_ See the [roadmap][4] for a list of available and upcoming features of the _sponsor edition_, and for demonstration purposes, [__the official docs built