mkdocs-conia

Name	mkdocs-conia JSON
Version	0.1.12 JSON
	download
home_page	https://github.com/coniadev/mkdocs-conia
Summary	Default mkdocs theme for Conia projects
upload_time	2023-11-11 08:49:24
maintainer
docs_url	None
author	ebene fünf GmbH
requires_python
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            MkDocs Conia Theme
==================

This is a theme for MkDocs which is mainly used in [Conia](https://conia.dev) projects 

## Installation

Install the package from PyPi using `pip`:

    pip install mkdocs-conia

Add the theme to your `mkdocs.yml` file:

    theme:
        name: conia

## 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` 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 setup.py bdist_wheel
    twine upload dist/*

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/coniadev/mkdocs-conia",
    "name": "mkdocs-conia",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "ebene f\u00fcnf GmbH",
    "author_email": "conia@ebenefuenf.de",
    "download_url": "",
    "platform": null,
    "description": "MkDocs Conia Theme\n==================\n\nThis is a theme for MkDocs which is mainly used in [Conia](https://conia.dev) projects \n\n## Installation\n\nInstall the package from PyPi using `pip`:\n\n    pip install mkdocs-conia\n\nAdd the theme to your `mkdocs.yml` file:\n\n    theme:\n        name: conia\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` 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 setup.py bdist_wheel\n    twine upload dist/*\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Default mkdocs theme for Conia projects",
    "version": "0.1.12",
    "project_urls": {
        "Homepage": "https://github.com/coniadev/mkdocs-conia"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4dc0a3f59ed646e31edddeacf971e9c4600b4ca2d4366dc07278733c0823ee96",
                "md5": "f39940d918217786768e5aa7515b1e0c",
                "sha256": "bad28643291acd12b0c857dafc66c6e4bc82f080d8fc168291b7e3aa88c507df"
            },
            "downloads": -1,
            "filename": "mkdocs_conia-0.1.12-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f39940d918217786768e5aa7515b1e0c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 104606,
            "upload_time": "2023-11-11T08:49:24",
            "upload_time_iso_8601": "2023-11-11T08:49:24.571273Z",
            "url": "https://files.pythonhosted.org/packages/4d/c0/a3f59ed646e31edddeacf971e9c4600b4ca2d4366dc07278733c0823ee96/mkdocs_conia-0.1.12-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-11 08:49:24",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "coniadev",
    "github_project": "mkdocs-conia",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "mkdocs-conia"
}