MkDocs Vacant Planet Theme
=========================
This is a theme for MkDocs which is mainly used in [VacantPlanet](https://vacantplanet.dev) projects
## Installation
Install the package from PyPi using `pip`:
pip install mkdocs-vacantplanet
Add the theme to your `mkdocs.yml` file:
theme:
name: vacantplanet
## Development server
mkdocs serve -w theme
## Styles
Install Dart Sass via `npm install -g sass`. During develompment:
sass --watch styles:theme
## Deploy to PyPi
Install `twine` and `build` if not already done. Bump version number in `setup.py`, then:
git tag -a vX.X.X -m "Version X.X.X"
git push origin vX.X.X
sass --style=compressed --no-source-map styles:theme
python -m build
python -m twine upload dist/*
Raw data
{
"_id": null,
"home_page": "https://github.com/vacantplanet/mkdocs-theme",
"name": "mkdocs-vacantplanet",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "ebene f\u00fcnf GmbH",
"author_email": "vacantplanet@ebenefuenf.de",
"download_url": "https://files.pythonhosted.org/packages/7b/4f/7be8f72723757147b929ab4091ceddd6d0b10c999bb74e935e6e3be0119c/mkdocs_vacantplanet-0.1.13.tar.gz",
"platform": null,
"description": "MkDocs Vacant Planet Theme\n=========================\n\nThis is a theme for MkDocs which is mainly used in [VacantPlanet](https://vacantplanet.dev) projects \n\n## Installation\n\nInstall the package from PyPi using `pip`:\n\n pip install mkdocs-vacantplanet\n\nAdd the theme to your `mkdocs.yml` file:\n\n theme:\n name: vacantplanet\n\n## Development server\n\n mkdocs serve -w theme \n\n## Styles\n\nInstall Dart Sass via `npm install -g sass`. During develompment:\n\n sass --watch styles:theme\n\n## Deploy to PyPi\n\nInstall `twine` and `build` if not already done. Bump version number in `setup.py`, then:\n\n git tag -a vX.X.X -m \"Version X.X.X\"\n git push origin vX.X.X\n sass --style=compressed --no-source-map styles:theme\n python -m build\n python -m twine upload dist/*\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Default mkdocs theme for VacantPlanet projects",
"version": "0.1.13",
"project_urls": {
"Homepage": "https://github.com/vacantplanet/mkdocs-theme"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c8733ffc9de31ee546109556278c86688dfe259484cc945fb8e72f7df3c67d91",
"md5": "25ff0633ad4af95c6bf4112016acc67e",
"sha256": "900e19cac14758b8e99b95cdd29dbf40a3b0ede77254efdcf1e7fa88ceb55356"
},
"downloads": -1,
"filename": "mkdocs_vacantplanet-0.1.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "25ff0633ad4af95c6bf4112016acc67e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 104726,
"upload_time": "2024-08-14T15:25:48",
"upload_time_iso_8601": "2024-08-14T15:25:48.978558Z",
"url": "https://files.pythonhosted.org/packages/c8/73/3ffc9de31ee546109556278c86688dfe259484cc945fb8e72f7df3c67d91/mkdocs_vacantplanet-0.1.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7b4f7be8f72723757147b929ab4091ceddd6d0b10c999bb74e935e6e3be0119c",
"md5": "03fdbf34073e9e044146105844675090",
"sha256": "f350087da7f05049ae6554b962fe0d08dfef839a2dda2740f646d79e9a6efaac"
},
"downloads": -1,
"filename": "mkdocs_vacantplanet-0.1.13.tar.gz",
"has_sig": false,
"md5_digest": "03fdbf34073e9e044146105844675090",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 105749,
"upload_time": "2024-08-14T15:25:50",
"upload_time_iso_8601": "2024-08-14T15:25:50.611672Z",
"url": "https://files.pythonhosted.org/packages/7b/4f/7be8f72723757147b929ab4091ceddd6d0b10c999bb74e935e6e3be0119c/mkdocs_vacantplanet-0.1.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-14 15:25:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "vacantplanet",
"github_project": "mkdocs-theme",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "mkdocs-vacantplanet"
}
JSON
