From f33c105c24b2e571846b8206a44caae333086c4b Mon Sep 17 00:00:00 2001 From: WEN Hao Date: Sat, 25 Nov 2023 17:03:17 +0800 Subject: [PATCH] update README.md --- README.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 01af1ec..bf4ac2e 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,9 @@ [![codecov](https://codecov.io/github/DeepPSP/sphinx-emoji-favicon/graph/badge.svg?token=XO53nHzvUM)](https://codecov.io/github/DeepPSP/sphinx-emoji-favicon) [![pytest](https://github.com/DeepPSP/sphinx-emoji-favicon/actions/workflows/run-pytest.yml/badge.svg)](https://github.com/DeepPSP/sphinx-emoji-favicon/actions/workflows/run-pytest.yml) [![license](https://img.shields.io/github/license/DeepPSP/sphinx-emoji-favicon?style=flat-square)](LICENSE) +![GitHub Release Date - Published_At](https://img.shields.io/github/release-date/DeepPSP/sphinx-emoji-favicon) [![downloads](https://img.shields.io/pypi/dm/sphinx-emoji-favicon?style=flat-square)](https://pypistats.org/packages/sphinx-emoji-favicon) +![GitHub commits since latest release (by SemVer including pre-releases)](https://img.shields.io/github/commits-since/DeepPSP/sphinx-emoji-favicon/latest) A simple sphinx extension to add emoji favicon to your sphinx site. @@ -28,7 +30,7 @@ Add `sphinx_emoji_favicon` to your `conf.py`: ```python extensions = [ ... - 'sphinx_emoji_favicon', + "sphinx_emoji_favicon", ... ] ``` @@ -36,7 +38,17 @@ extensions = [ Then add the following to your `conf.py`: ```python -emoji_favicon = '🦄' -# or emoji_favicon = ':unicorn:' -# or emoji_favicon = ':独角兽:' +emoji_favicon = "🦄" +# or emoji_favicon = ":unicorn:" +# or emoji_favicon = ":独角兽:" +``` + +or with additional options: + +```python +emoji_favicon = { + "emoji": ":lion:", # "Leo" in English + "language": "fr", + "twemoji_cdns": "https://cdn.staticfile.org/twemoji/", # or with version and/or assets type: "https://cdn.staticfile.org/twemoji/13.1.0/72x72/" +} ```