Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wenh06 committed Nov 25, 2023
1 parent f639c48 commit f33c105
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -28,15 +30,25 @@ Add `sphinx_emoji_favicon` to your `conf.py`:
```python
extensions = [
...
'sphinx_emoji_favicon',
"sphinx_emoji_favicon",
...
]
```

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/"
}
```

0 comments on commit f33c105

Please sign in to comment.