OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Added guide for custom icons in social links

Browse Source
This commit is contained in:
squidfunk 2020-07-23 13:52:42 +02:00
parent 32cc1c57b2
commit c3d2567d11
3 changed files with 24 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/setup/adding-social-links.md
View File

@ -88,3 +88,17 @@ For each entry, the following fields are available:
link: https://twitter.com/squidfunk link: https://twitter.com/squidfunk
name: squidfunk on Twitter 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

4
docs/setup/changing-the-logo-and-icons.md
View File

@ -60,8 +60,8 @@ theme:
[:octicons-file-code-24: Source][5] · [:octicons-workflow-24: Extension][6] [:octicons-file-code-24: Source][5] · [:octicons-workflow-24: Extension][6]
The [Emoji][6] extension, which is part of [Python Markdown Extensions][7], The [Emoji][6] extension, which is part of [Python Markdown Extensions][7],
adds the ability to __integrate custom icons__ in the `*.svg` file format, adds the ability to __integrate icons__ in the `*.svg` file format, which are
which are inlined into the HTML when [building your site][8]: inlined into the HTML when [building your site][8]:
``` yaml ``` yaml
markdown_extensions: markdown_extensions:

11
docs/sponsorship.md
View File

@ -2,7 +2,7 @@
template: overrides/main.html template: overrides/main.html
--- ---
# <span hidden>Sponsorship</span> :logo: :material-plus: :octicons-heart-fill-24:{: .tx-sponsor__heart } # <span hidden>Sponsorship</span> :logo: :material-plus: :octicons-heart-fill-24:{: .tx-heart }
Material for MkDocs uses the [sponsorware][1] release strategy, which means that Material for MkDocs uses the [sponsorware][1] release strategy, which means that
__new features are first exclusively released to sponsors__. Read on to learn __new features are first exclusively released to sponsors__. Read on to learn
@ -15,13 +15,18 @@ latest features before everybody else.
## How sponsorship works ## 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 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 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 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 _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 See the [roadmap][4] for a list of available and upcoming features of the
_sponsor edition_, and for demonstration purposes, [__the official docs built _sponsor edition_, and for demonstration purposes, [__the official docs built