<p align="center">
<a href="https://squidfunk.github.io/mkdocs-material/">
<img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/logo.png" width="320" alt="Material for MkDocs">
</a>
</p>
<p align="center">
<strong>
A
<a href="https://traefik.io/">Traefik Labs</a>
<a href="https://material.io/">Material Design</a>
theme for
<a href="https://www.mkdocs.org/">MkDocs</a>
</strong>
</p>
## Quick start
Material for MkDocs can be installed with `pip`:
```sh
pip install mkdocs-traefiklabs
```
Add the following line to `mkdocs.yml`:
```yaml
theme:
name: traefik-labs
```
## How to run the project in Dev mode
### Pre-requisites
- Check your node version, the .nvmrc file mentions the expected version.
If you use nvm, you can run `nvm use` to set the correct node version to the environment.
- Check if you have `mkdocs` installed locally (it requires Python).
You can find installation instructions here: https://www.mkdocs.org/user-guide/installation/
### Steps:
- Install the dependencies `npm install`
- `npm run build` - this will generate the '/material' folder with the compiled theme (you need to re-run this if you add assets)
- `npm run start` - leave this running in a terminal, it will watch for code changes and rebuild the content (but not the assets)
- `npm run serve` - will launch a dev server at 127.0.0.1:8000 with the current theme, it has hot reload (not very precise, sometimes you need to hard refresh the page)
> If you wish to set the context to see other products information, you need to set the `product` config in the `mkdocs.yml` file in the project's root directory. The dev server should automatically reload and you will see the changes in the browser.
### Reminders:
- The 'material' directory generated by the `npm run build` is the one used in the documentation, so please don't forget running the build once you finish all the changes.
TODO: add git hooks and run build on pre-push.
Raw data
{
"_id": null,
"home_page": "http://traefik.io",
"name": "mkdocs-traefiklabs",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "mkdocs,traefik labs,documentation,theme",
"author": "traefiklabs",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/29/a6/7a81775a3149c3ebe8f839f965b11a2f005981fd9a0088ad73f17bfa1683/mkdocs-traefiklabs-100.0.20.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <a href=\"https://squidfunk.github.io/mkdocs-material/\">\n <img src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/logo.png\" width=\"320\" alt=\"Material for MkDocs\">\n </a>\n</p>\n\n<p align=\"center\">\n <strong>\n A \n <a href=\"https://traefik.io/\">Traefik Labs</a> \n <a href=\"https://material.io/\">Material Design</a> \n theme for \n <a href=\"https://www.mkdocs.org/\">MkDocs</a>\n </strong>\n</p>\n\n## Quick start\n\nMaterial for MkDocs can be installed with `pip`:\n\n```sh\npip install mkdocs-traefiklabs\n```\n\nAdd the following line to `mkdocs.yml`:\n\n```yaml\ntheme:\n name: traefik-labs\n```\n\n## How to run the project in Dev mode\n\n### Pre-requisites\n\n- Check your node version, the .nvmrc file mentions the expected version.\n If you use nvm, you can run `nvm use` to set the correct node version to the environment.\n- Check if you have `mkdocs` installed locally (it requires Python).\n You can find installation instructions here: https://www.mkdocs.org/user-guide/installation/\n\n### Steps:\n\n- Install the dependencies `npm install`\n- `npm run build` - this will generate the '/material' folder with the compiled theme (you need to re-run this if you add assets)\n- `npm run start` - leave this running in a terminal, it will watch for code changes and rebuild the content (but not the assets)\n- `npm run serve` - will launch a dev server at 127.0.0.1:8000 with the current theme, it has hot reload (not very precise, sometimes you need to hard refresh the page)\n\n> If you wish to set the context to see other products information, you need to set the `product` config in the `mkdocs.yml` file in the project's root directory. The dev server should automatically reload and you will see the changes in the browser.\n\n### Reminders:\n\n- The 'material' directory generated by the `npm run build` is the one used in the documentation, so please don't forget running the build once you finish all the changes.\n TODO: add git hooks and run build on pre-push.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Traefik Labs branded Material Design theme for MkDocs",
"version": "100.0.20",
"project_urls": {
"Homepage": "http://traefik.io"
},
"split_keywords": [
"mkdocs",
"traefik labs",
"documentation",
"theme"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6afee17ef2952cb92ddf5c71f28ecae6e178b7c5a4fe77576b5d69da6623f517",
"md5": "e630ed6200a17b87ecd8d704c57f61a5",
"sha256": "5987ce79852840b83727e19e8b07cc7f1726bb495223d50e4567364ccd72385e"
},
"downloads": -1,
"filename": "mkdocs_traefiklabs-100.0.20-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "e630ed6200a17b87ecd8d704c57f61a5",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 5538044,
"upload_time": "2023-07-20T15:38:09",
"upload_time_iso_8601": "2023-07-20T15:38:09.674940Z",
"url": "https://files.pythonhosted.org/packages/6a/fe/e17ef2952cb92ddf5c71f28ecae6e178b7c5a4fe77576b5d69da6623f517/mkdocs_traefiklabs-100.0.20-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "29a67a81775a3149c3ebe8f839f965b11a2f005981fd9a0088ad73f17bfa1683",
"md5": "6b1c8de5452581758691be799df79753",
"sha256": "0c758f7c93ddbc93d86ccb25900de9858c374f621a333f6c35cb7b2272572c90"
},
"downloads": -1,
"filename": "mkdocs-traefiklabs-100.0.20.tar.gz",
"has_sig": false,
"md5_digest": "6b1c8de5452581758691be799df79753",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3189681,
"upload_time": "2023-07-20T15:38:12",
"upload_time_iso_8601": "2023-07-20T15:38:12.147674Z",
"url": "https://files.pythonhosted.org/packages/29/a6/7a81775a3149c3ebe8f839f965b11a2f005981fd9a0088ad73f17bfa1683/mkdocs-traefiklabs-100.0.20.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-20 15:38:12",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mkdocs-traefiklabs"
}
JSON