{"id":17029783,"url":"https://github.com/lukecarrier/mkdocs-theme-bootstrap4","last_synced_at":"2025-04-12T12:11:31.656Z","repository":{"id":35151132,"uuid":"212434368","full_name":"LukeCarrier/mkdocs-theme-bootstrap4","owner":"LukeCarrier","description":"A vanilla Bootstrap 4 theme for MkDocs","archived":false,"fork":false,"pushed_at":"2025-03-06T03:41:54.000Z","size":677,"stargazers_count":6,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-11T19:57:19.859Z","etag":null,"topics":["bootstrap","bootstrap4","mkdocs","mkdocs-theme"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/mkdocs-theme-bootstrap4/","language":"HTML","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/LukeCarrier.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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-10-02T20:24:05.000Z","updated_at":"2024-11-23T00:57:48.000Z","dependencies_parsed_at":"2024-06-07T23:33:50.981Z","dependency_job_id":"6680236a-544b-4bed-8f33-ae0a715c5d0b","html_url":"https://github.com/LukeCarrier/mkdocs-theme-bootstrap4","commit_stats":{"total_commits":49,"total_committers":3,"mean_commits":"16.333333333333332","dds":"0.24489795918367352","last_synced_commit":"229857297a5410d1ccc84e999645d32ac67a4b6f"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LukeCarrier%2Fmkdocs-theme-bootstrap4","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LukeCarrier%2Fmkdocs-theme-bootstrap4/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LukeCarrier%2Fmkdocs-theme-bootstrap4/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LukeCarrier%2Fmkdocs-theme-bootstrap4/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LukeCarrier","download_url":"https://codeload.github.com/LukeCarrier/mkdocs-theme-bootstrap4/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248565074,"owners_count":21125417,"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":["bootstrap","bootstrap4","mkdocs","mkdocs-theme"],"created_at":"2024-10-14T08:02:04.907Z","updated_at":"2025-04-12T12:11:31.631Z","avatar_url":"https://github.com/LukeCarrier.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Bootstrap 4 theme for MkDocs\n\nA vanilla Bootstrap 4 theme.\n\n---\n\n## Screenshot\n\n\u003cimg style=\"max-width:100%;\" alt=\"Screenshot of Bootstrap4 theme for MkDocs\" src=\"screenshots/mkdocs-bootstrap4.png\" align=\"center\" /\u003e\u003cbr /\u003e\n\n## Quick start\n\nFirst install the package:\n\n```\n$ pip install mkdocs-theme-bootstrap4\n```\n\nThen enable it:\n\n```yaml\ntheme:\n    name: bootstrap4\n```\n\n## Configuration\n\nPlace these additional options under the `theme:` section of your `mkdocs.yml` configuration to change the theme's behaviour.\n\n```yaml\n# Show next/previous links between pages?\nnext_previous: true\n```\n\n### Bootstrap features\n\nSome Bootstrap components require the addition of additional CSS classes. To enable these, add the following `plugins` in `mkdocs.yml`:\n\n```yaml\nplugins:\n    - bootstrap4-blockquotes\n    - bootstrap4-tables\n```\n\n## Hacking\n\nFirst, install the dependencies:\n\n* [Python 2](https://www.python.org/downloads/), for some of our dependencies.\n* [Python 3](https://www.python.org/downloads/), for the package build process.\n* [Yarn](https://yarnpkg.com/en/docs/cli/install), for managing frontend dependencies.\n\nEnsure that Python 2 is found on your path before Python 3, else you'll get errors from `node-gyp` later. If you're unable to do this, set the environment variable `npm_config_python` to a command that'll launch Python 2 (`py -2` on Windows, `python2` elsewhere).\n\nOn Windows:\n\n* It's easiest to not put Python on your path and instead rely on the [`py` CLI](https://docs.python.org/using/windows.html#python-launcher-for-windows).\n* You'll need the build tools necessary to install native dependencies: `npm install -g --production windows-build-tools`.\n\nTo get completion working in your editor, set up a virtual environment in the root of this repository and install MkDocs:\n\n```\n$ pip3 install --user --upgrade setuptools twine wheel\n$ python3 -m venv venv\n$ . venv/bin/activate\n$ pip install -r requirements.txt\n```\n\nTo install the plugin onto a local MkDocs site in editable form:\n\n```\n$ pip install --editable /path/to/mkdocs-theme-bootstrap4\n```\n\n## Upgrading dependencies\n\nTo upgrade the dependencies, install `pip-upgrader`:\n\n```console\n. venv/bin/activate\npip install -r requirements.dev.txt\n```\n\nThen proceed to update the dependencies:\n\n```console\npip-upgrade requirements.dev.txt\n```\n\nThe node dependencies can be updated with Yarn:\n\n```console\nyarn upgrade\n```\n\n## Releasing\n\nBuild the distributable package:\n\n```\n$ python3 setup.py sdist bdist_wheel\n```\n\nPush it to the PyPI test instance:\n\n```\n$ python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*\n```\n\nTest it inside a virtual environment:\n\n```\n$ pip install --index-url https://test.pypi.org/simple/ --no-deps mkdocs-drawio-exporter\n```\n\nLet's go live:\n\n```\n$ python3 -m twine upload dist/*\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flukecarrier%2Fmkdocs-theme-bootstrap4","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flukecarrier%2Fmkdocs-theme-bootstrap4","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flukecarrier%2Fmkdocs-theme-bootstrap4/lists"}