{"id":15362077,"url":"https://github.com/bashtage/sphinx-material","last_synced_at":"2025-05-14T18:03:11.921Z","repository":{"id":45231789,"uuid":"203251209","full_name":"bashtage/sphinx-material","owner":"bashtage","description":"A material-based, responsive theme inspired by mkdocs-material","archived":false,"fork":false,"pushed_at":"2024-11-26T06:19:37.000Z","size":25969,"stargazers_count":328,"open_issues_count":39,"forks_count":93,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-13T19:24:11.784Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bashtage.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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-08-19T21:14:37.000Z","updated_at":"2025-04-05T02:49:35.000Z","dependencies_parsed_at":"2024-06-18T13:35:03.654Z","dependency_job_id":"ab1feddc-68e3-454d-b931-6f0abef1df0b","html_url":"https://github.com/bashtage/sphinx-material","commit_stats":{"total_commits":93,"total_committers":16,"mean_commits":5.8125,"dds":0.3763440860215054,"last_synced_commit":"0d31923e0fb08e85027c3e7f03d12673209872e3"},"previous_names":[],"tags_count":33,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bashtage%2Fsphinx-material","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bashtage%2Fsphinx-material/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bashtage%2Fsphinx-material/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bashtage%2Fsphinx-material/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bashtage","download_url":"https://codeload.github.com/bashtage/sphinx-material/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254198452,"owners_count":22030964,"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":["hacktoberfest"],"created_at":"2024-10-01T12:58:26.459Z","updated_at":"2025-05-14T18:03:06.905Z","avatar_url":"https://github.com/bashtage.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"Material Sphinx Theme\n=====================\n\n**Continuous Integration**\n\n|Travis Build Status|\n\n**Release**\n\n|PyPI Status|\n\n**License**\n\n|MIT License|\n\nA Material Design theme for Sphinx documentation. Based on\n`Material for MkDocs \u003chttps://squidfunk.github.io/mkdocs-material/\u003e`_,\nand `Guzzle Sphinx Theme \u003chttps://github.com/guzzle/guzzle_sphinx_theme\u003e`_.\n\nSee the theme's `demonstration site \u003chttps://bashtage.github.io/sphinx-material/\u003e`_\nfor examples of rendered rst.\n\nInstallation\n------------\n\nInstall via pip:\n\n.. code-block:: bash\n\n    $ pip install sphinx-material\n\nor if you have the code checked out locally:\n\n.. code-block:: bash\n\n    $ python setup.py install\n\nConfiguration\n-------------\n\nAdd the following to your conf.py:\n\n.. code-block:: python\n\n    html_theme = 'sphinx_material'\n\n\nThere are a lot more ways to customize this theme, as this more comprehensive\nexample shows:\n\n.. code-block:: python\n\n    # Required theme setup\n    html_theme = 'sphinx_material'\n\n    # Set link name generated in the top bar.\n    html_title = 'Project Title'\n\n    # Material theme options (see theme.conf for more information)\n    html_theme_options = {\n\n        # Set the name of the project to appear in the navigation.\n        'nav_title': 'Project Name',\n\n        # Set you GA account ID to enable tracking\n        'google_analytics_account': 'UA-XXXXX',\n\n        # Specify a base_url used to generate sitemap.xml. If not\n        # specified, then no sitemap will be built.\n        'base_url': 'https://project.github.io/project',\n\n        # Set the color and the accent color\n        'color_primary': 'blue',\n        'color_accent': 'light-blue',\n\n        # Set the repo location to get a badge with stats\n        'repo_url': 'https://github.com/project/project/',\n        'repo_name': 'Project',\n\n        # Visible levels of the global TOC; -1 means unlimited\n        'globaltoc_depth': 3,\n        # If False, expand all TOC entries\n        'globaltoc_collapse': False,\n        # If True, show hidden TOC entries\n        'globaltoc_includehidden': False,\n    }\n\nCustomizing the layout\n----------------------\n\nYou can customize the theme by overriding Jinja template blocks. For example,\n'layout.html' contains several blocks that can be overridden or extended.\n\nPlace a 'layout.html' file in your project's '/_templates' directory.\n\n.. code-block:: bash\n\n    mkdir source/_templates\n    touch source/_templates/layout.html\n\nThen, configure your 'conf.py':\n\n.. code-block:: python\n\n    templates_path = ['_templates']\n\nFinally, edit your override file 'source/_templates/layout.html':\n\n::\n\n    {# Import the theme's layout. #}\n    {% extends '!layout.html' %}\n\n    {%- block extrahead %}\n    {# Add custom things to the head HTML tag #}\n    {# Call the parent block #}\n    {{ super() }}\n    {%- endblock %}\n\n.. |Travis Build Status| image:: https://travis-ci.com/bashtage/sphinx-material.svg?branch=master\n   :target: https://travis-ci.com/bashtage/sphinx-material\n\n.. |PyPI Status| image:: https://badge.fury.io/py/sphinx-material.svg\n    :target: https://badge.fury.io/py/sphinx-material\n\n.. |MIT License| image:: https://img.shields.io/badge/License-MIT-blue.svg\n   :target: https://opensource.org/licenses/MIT-Clause\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbashtage%2Fsphinx-material","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbashtage%2Fsphinx-material","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbashtage%2Fsphinx-material/lists"}