{"id":18085104,"url":"https://github.com/jwodder/kbits-theme","last_synced_at":"2025-06-29T03:37:13.729Z","repository":{"id":66104053,"uuid":"287387443","full_name":"jwodder/kbits-theme","owner":"jwodder","description":"Yet another Pelican theme","archived":false,"fork":false,"pushed_at":"2021-11-19T23:05:39.000Z","size":371,"stargazers_count":1,"open_issues_count":23,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-16T13:05:31.731Z","etag":null,"topics":["pelican","pelican-theme"],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jwodder.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.md","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":"2020-08-13T21:56:34.000Z","updated_at":"2025-01-15T00:41:30.000Z","dependencies_parsed_at":null,"dependency_job_id":"5d585d78-d40f-4ce1-a751-38887ac2a4a1","html_url":"https://github.com/jwodder/kbits-theme","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/jwodder/kbits-theme","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwodder%2Fkbits-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwodder%2Fkbits-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwodder%2Fkbits-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwodder%2Fkbits-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jwodder","download_url":"https://codeload.github.com/jwodder/kbits-theme/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwodder%2Fkbits-theme/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262528403,"owners_count":23324545,"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":["pelican","pelican-theme"],"created_at":"2024-10-31T15:09:23.795Z","updated_at":"2025-06-29T03:37:13.697Z","avatar_url":"https://github.com/jwodder.png","language":"CSS","readme":"This is the `Pelican \u003chttps://getpelican.com/\u003e`_ theme for my blog `\"Knowledge\nBits\" \u003chttps://jwodder.github.io/kbits/\u003e`_, split off into a separate\nrepository so that it can be reused by others.  The theme is a mixture of\nsimilar styles from various sources, mostly the styles GitHub uses to render\nmarkup.\n\nA demo of the theme in action, designed to show off as many features \u0026 styles\nas possible, can be found at \u003chttps://jwodder.github.io/kbits-theme-demo/\u003e.\n\n\nFeatures\n========\n\n- Article metadata (posted date, last modified date, authors, category, tags,\n  translations, and any custom fields you specify) is displayed in a nice table\n  underneath the article title\n\n- Links to articles' source on GitHub can optionally be added to metadata\n  listings\n\n- You can add arbitrary lists of links to the navigation pane, not just \"Links\"\n  and \"Social\"\n\n- There is CSS support for the Docutils/reStructuredText table classes\n  \"booktabs\" and \"borderless\" as well as for left-aligned, centered, and\n  right-aligned tables\n\n- Colorful reStructuredText admonitions, topics, and sidebars\n\n- Strings are HTML-escaped where necessary, so you can safely put angle\n  brackets in your article titles, categories, and tags\n\n- ``MENUITEMS`` accepts relative URLs and automatically prepends ``SITEURL`` to\n  them\n\n- Support for specifying a favicon\n\n- Support for the autopages_ plugin\n\n- If you've disabled author pages by setting both ``AUTHOR_SAVE_AS`` and\n  ``AUTHOR_URL`` to ``None`` or the empty string, then author names will not be\n  hyperlinked.\n\n- MathJax can be automatically enabled on every page\n\n.. _autopages:\n   https://github.com/getpelican/pelican-plugins/tree/master/autopages\n\n\nTheme Settings\n==============\n\nkbits-theme recognizes the following theme settings:\n\n``MENU_NAME``\n   The name to display above the main menu on the navigation pane.  Defaults to\n   no name.\n\n``MENUITEMS``\n   A list of (Title, URL) pairs for additional menu items to appear at the\n   beginning of the main menu in the navigation pane.  If a given URL is\n   relative (does not begin with either ``http://`` or ``https://``), then\n   ``{{SITEURL}}/`` is prepended to it.  This allows you to link to locations\n   on your site without having to give the full URL.\n\n``PAGES_MENU = False``\n   If true, pages will be given their own menu in the navigation pane,\n   after the main menu but before the categories menu and any menus defined\n   with ``EXTRA_MENUS``.\n\n``PAGES_MENU_NAME = \"Pages\"``\n   The name to display above the pages menu (if there is one) on the\n   navigation pane\n\n``CATEGORIES_MENU = False``\n   If true, categories will be given their own menu in the navigation pane,\n   after the main menu and pages menu but before any menus defined with\n   ``EXTRA_MENUS``.\n\n``CATEGORIES_MENU_NAME = \"Categories\"``\n   The name to display above the categories menu (if there is one) on the\n   navigation pane\n\n``EXTRA_MENUS``\n   A list of (Menu Name, Link List) pairs defining extra lists of links to add\n   to the navigation pane beneath all other menus.  Each \"Link List\" is a\n   sublist of (Link Name, Link URL) pairs.\n\n   If a given link URL is relative (does not begin with either ``http://`` or\n   ``https://``), then ``{{SITEURL}}/`` is prepended to it.  This allows you to\n   link to locations on your site without having to give the full URL.\n\n   For example, the following setting:\n\n   .. code:: python\n\n       EXTRA_MENUS = [\n           ('Social', [\n               ('My Twitter', 'https://twitter.com/…'),\n               ('My Mastodon', 'https://…'),\n               ('My GitHub', 'https://github.com/…'),\n           ]),\n           ('Favorite Tags', [\n               ('Python', 'tags/python.html'),\n               ('Pelican', 'tags/pelican.html'),\n           ]),\n       ]\n\n   causes the following to be added to the navigation pane on the left of the\n   page::\n\n        Social\n        * My Twitter\n        * My Mastodon\n        * My GitHub\n\n        Favorite Tags\n        * Python\n        * Pelican\n\n``SITESUBTITLE``\n   A subtitle to appear in the header\n\n``FOOTER_HTML``\n   HTML to display at the bottom of every page, centered and in small font.\n\n``GITHUB_SOURCE_URL``\n   If your site's repository is hosted on GitHub, setting this variable to the\n   repository's URL (in the form ``\"https://github.com/$OWNER/$REPO\"``, without\n   trailing ``.git``) will add a \"Page Source\" entry to each article's metadata\n   table pointing to the article source file on GitHub.  Setting this value\n   also requires setting ``PATH_IN_REPO``.\n\n``GITHUB_SOURCE_BRANCH = \"master\"``\n   The branch of the ``GITHUB_SOURCE_URL`` repository on which the site's\n   source is located.\n\n``PATH_IN_REPO``\n   The ``/``-separated path to your content directory, relative to the root of\n   your repository.  This will usually be equal to ``PATH``.  This needs to be\n   set whenever ``GITHUB_SOURCE_URL`` is set.\n\n``FAVICON_URL``\n   A URL pointing to an image to use as the site's favicon.  If the URL is\n   relative (does not begin with either ``http://`` or ``https://``), then\n   ``{{SITEURL}}/`` is prepended to it.\n\n``FAVICON_TYPE``\n   The MIME type of your site's favicon\n\n``SHOW_AUTHOR = True``\n   Whether to show articles' authors in the metadata table\n\n``SHOW_AUTHOR_IN_LISTINGS = True``\n   Whether to show articles' authors in article listings (``index.html`` etc.)\n\n``USE_MATHJAX = False``\n   Whether to enable MathJax on every page of the site\n\n``MATHJAX_SCRIPT = \"https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml.js\"``\n   The MathJax script to load\n\n``MATHJAX_CONFIG = {}``\n   Configuration settings for MathJax.  Configuration is applied assuming\n   version 3 of MathJax is in use.  Only JSON-serializable values are supported\n   in ``MATHJAX_CONFIG``.\n\n``EXTRA_METADATA_FIELDS``\n   A list of (Field Name, Article Attribute) pairs specifying additional\n   metadata fields to list in articles' metadata tables.  The \"Field Name\" is\n   the text to label the field with in the table (minus the colon which will be\n   automatically appended), and the \"Article Attribute\" is the name of the\n   field as available as an attribute of an ``Article`` object (i.e., the name\n   of the field as written in your document metadata, but converted to\n   all-lowercase).  If a given field is empty or not set on an article, it is\n   not listed in that article's metadata table.\n\n   For example, if you include an \"``:ORCID:``\" field in the docinfo of your\n   articles, you can include ``(\"Author ORCID\", \"orcid\")`` in\n   ``EXTRA_METADATA_FIELDS`` to cause the field to be listed in the metadata\n   table with a label of \"Author ORCID:\".\n\n\nThird-Party Assets\n==================\n\nThis theme contains several assets taken or derived from third-party sources:\n\n.. list-table::\n    :header-rows: 1\n\n    * - File\n      - Source\n      - License \u0026 Copyright\n    * - ``static/css/admonitions.css``\n      - `sphinx-rtd-theme \u003chttps://github.com/readthedocs/sphinx_rtd_theme\u003e`_\n      - Released under the MIT License.  Copyright (c) 2013-2018 Dave Snider,\n        Read the Docs, Inc. \u0026 contributors\n    * - ``static/css/blockquote.css``\n      - \u003chttp://primer.style/css\u003e\n      - Released under MIT license. Copyright (c) 2019 GitHub Inc.\n    * - ``static/css/docinfo-topics.css``\n      - `Sphinx \u003chttps://www.sphinx-doc.org\u003e`_\n      - Released under the BSD license.  Copyright 2007-2020 by the Sphinx\n        team.\n    * - ``static/css/docutils.css``\n      - `Docutils \u003chttps://docutils.sourceforge.io\u003e`_, ``html4css1.css`` file\n      - Public domain\n    * - ``static/css/headers.css``\n      - \u003chttp://primer.style/css\u003e\n      - Released under MIT license. Copyright (c) 2019 GitHub Inc.\n    * - ``static/css/kbd.css``\n      - \u003chttp://primer.style/css\u003e\n      - Released under MIT license. Copyright (c) 2019 GitHub Inc.\n    * - ``static/css/sidebar.css``\n      - `sphinx-rtd-theme \u003chttps://github.com/readthedocs/sphinx_rtd_theme\u003e`_\n      - Released under the MIT License.  Copyright (c) 2013-2018 Dave Snider,\n        Read the Docs, Inc. \u0026 contributors\n    * - ``static/css/table.css``\n      - \u003chttp://primer.style/css\u003e\n      - Released under MIT license. Copyright (c) 2019 GitHub Inc.\n    * - ``static/css/topic.css``\n      - `pallets-sphinx-themes \u003chttps://github.com/pallets/pallets-sphinx-themes\u003e`_\n      - Released under the BSD 3-Clause license.  Copyright 2007 Pallets.\n    * - ``static/images/rss.svg``\n      - `Wikimedia Commons \u003chttps://commons.wikimedia.org\u003e`_, `[link]\n        \u003chttps://commons.wikimedia.org/wiki/File:Generic_Feed-icon.svg\u003e`_\n      - Released under the GNU GPL v2+, GNU LGPL v2.1+, and MPL 1.1\n    * - ``static/fonts/BabelStoneShapes.{ttf,woff,woff2}``\n      - `BabelStone Shapes \u003chttps://babelstone.co.uk/Fonts/Shapes.html\u003e`_ v.\n        13.0.1 by BabelStone\n      - Released under the SIL Open Font License 1.1\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjwodder%2Fkbits-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjwodder%2Fkbits-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjwodder%2Fkbits-theme/lists"}