{"id":19931059,"url":"https://github.com/sphinx-contrib/emojicodes","last_synced_at":"2025-04-06T00:10:51.830Z","repository":{"id":46523791,"uuid":"170754654","full_name":"sphinx-contrib/emojicodes","owner":"sphinx-contrib","description":"An extension to use emoji codes in your Sphinx documentation! 😍","archived":false,"fork":false,"pushed_at":"2024-01-18T18:06:13.000Z","size":120,"stargazers_count":54,"open_issues_count":7,"forks_count":15,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-03-29T23:10:00.924Z","etag":null,"topics":["documentation","emoji","hacktoberfest","python","sphinx","sphinx-extension","sphinxcontrib","twemoji"],"latest_commit_sha":null,"homepage":"https://sphinxemojicodes.readthedocs.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sphinx-contrib.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-02-14T20:37:58.000Z","updated_at":"2025-02-23T17:21:00.000Z","dependencies_parsed_at":"2024-06-18T17:07:41.568Z","dependency_job_id":"38b063bc-2618-446d-a132-c321f397c913","html_url":"https://github.com/sphinx-contrib/emojicodes","commit_stats":{"total_commits":46,"total_committers":6,"mean_commits":7.666666666666667,"dds":"0.21739130434782605","last_synced_commit":"ea2b5e9f34d1620561e4634a8c53c87bee8906b8"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Femojicodes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Femojicodes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Femojicodes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Femojicodes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sphinx-contrib","download_url":"https://codeload.github.com/sphinx-contrib/emojicodes/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247415973,"owners_count":20935387,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","emoji","hacktoberfest","python","sphinx","sphinx-extension","sphinxcontrib","twemoji"],"created_at":"2024-11-12T23:05:56.835Z","updated_at":"2025-04-06T00:10:51.811Z","avatar_url":"https://github.com/sphinx-contrib.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Sphinx Emoji Codes\n==================\n\nAn extension to use emoji codes in your Sphinx documentation!\n\n.. code::\n\n   pip install sphinxemoji\n\n\nUsage\n-----\n\nEnable the Sphinx extension(s) in your ``conf.py`` file:\n\n.. code:: python\n\n   extensions = [\n       '...',\n       'sphinxemoji.sphinxemoji',\n   ]\n\nThen you can use emoji code replacements by writing them between bars:\n\n.. code:: rst\n\n   This text includes a smiley face |:smile:| and a snake too! |:snake:|\n\n   Don't you love it? |:heart_eyes:|\n\nYou can find the list of all supported emoji codes `in the project's documentation page\n\u003chttps://sphinxemojicodes.readthedocs.io/#supported-codes\u003e`_.\n\n\nConfiguration\n-------------\n\nIf you want a consistent emoji style instead of using the browser's default,\nyou can set it in your ``conf.py`` file:\n\n.. code:: python\n\n   sphinxemoji_style = 'twemoji'\n\nBy default Twemoji is obtained from a CDN. If you want to specify your own\nsource location (be it local or from another CDN), you can do so via the ``conf.py`` file:\n\n.. code:: python\n\n   sphinxemoji_source = 'https://unpkg.com/twemoji@latest/dist/twemoji.min.js'\n   # or: sphinxemoji_source = 'my-local-twemoji.min.js'\n\n\nBuild\n-----\n\nYou can build this package by running this command from the root directory:\n\n.. code::\n\n   python -m build\n\n\nNotes\n-----\n\nEmoji substitutions are processed after default substitutions like\n``|release|``, ``|version|`` and ``|today|``, but before any other\nsubstitutions in source files (i.e. emoji substitutions can be overriden).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-contrib%2Femojicodes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsphinx-contrib%2Femojicodes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-contrib%2Femojicodes/lists"}