# mkdocs-terminal
Terminal for MkDocs is a third party theme that brings the [Terminal.css](https://github.com/Gioni06/terminal.css) stylesheet to MkDocs documentation sites.
<img src="https://raw.githubusercontent.com/ntno/mkdocs-terminal/main/mkdocs-terminal.png" alt="Terminal for MkDocs theme preview" ><br>
In addition to simple, monospace styling, Terminal for MkDocs also provides:
- a built-in Search modal
- color palette options
- revision date display
- per-page or site-wide component hiding
- a flexible grid for displaying inline images
- section index pages
- and more
## Quick start
terminal.css theme for MkDocs can be installed with `pip`:
``` sh
pip install mkdocs-terminal
```
Add the following lines to `mkdocs.yml`:
``` yaml
theme:
name: terminal
```
## Documentation
[mkdocs-terminal docs](https://ntno.github.io/mkdocs-terminal/)
## Developer Info
[Terminal for MkDocs on GitHub](https://github.com/ntno/mkdocs-terminal)
[Terminal for MkDocs on PyPI](https://pypi.org/project/mkdocs-terminal)
[Theme Development README](DEVELOPER_README.md)
### License
**MIT License**
Copyright (c) 2023 Natan Organick
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Raw data
{
"_id": null,
"home_page": null,
"name": "mkdocs-terminal",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "documentation, mkdocs, theme",
"author": "Natan Organick",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/95/41/0d4ab5fcee2030f4800f0925ccbc03531d44f89686ad07db83cf2fd77854/mkdocs_terminal-4.7.0.tar.gz",
"platform": null,
"description": "# mkdocs-terminal\nTerminal for MkDocs is a third party theme that brings the [Terminal.css](https://github.com/Gioni06/terminal.css) stylesheet to MkDocs documentation sites. \n\n<img src=\"https://raw.githubusercontent.com/ntno/mkdocs-terminal/main/mkdocs-terminal.png\" alt=\"Terminal for MkDocs theme preview\" ><br>\n\nIn addition to simple, monospace styling, Terminal for MkDocs also provides:\n\n- a built-in Search modal\n- color palette options\n- revision date display\n- per-page or site-wide component hiding\n- a flexible grid for displaying inline images\n- section index pages\n- and more\n\n## Quick start\n\nterminal.css theme for MkDocs can be installed with `pip`:\n\n``` sh\npip install mkdocs-terminal\n```\n\nAdd the following lines to `mkdocs.yml`:\n\n``` yaml\ntheme:\n name: terminal\n```\n\n## Documentation\n[mkdocs-terminal docs](https://ntno.github.io/mkdocs-terminal/)\n\n## Developer Info\n[Terminal for MkDocs on GitHub](https://github.com/ntno/mkdocs-terminal) \n[Terminal for MkDocs on PyPI](https://pypi.org/project/mkdocs-terminal) \n[Theme Development README](DEVELOPER_README.md) \n\n\n### License\n\n**MIT License**\n\nCopyright (c) 2023 Natan Organick\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n",
"bugtrack_url": null,
"license": null,
"summary": "Terminal.css theme for MkDocs",
"version": "4.7.0",
"project_urls": {
"Documentation": "https://ntno.github.io/mkdocs-terminal",
"Issues": "https://github.com/ntno/mkdocs-terminal/issues",
"Source": "https://github.com/ntno/mkdocs-terminal"
},
"split_keywords": [
"documentation",
" mkdocs",
" theme"
],
"urls": [
{
"comment_text": "4.7.0",
"digests": {
"blake2b_256": "1d98062d03109576f3dc5a27bb3a2a74bea9b59aa4ed5d2b9b12f98a15a09fd8",
"md5": "d7ffd27e24c9eb433168d9c107a99d02",
"sha256": "6a223bcef762728f5bcdba045b4acabc3d119ae9215160693f45be8a09889815"
},
"downloads": -1,
"filename": "mkdocs_terminal-4.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d7ffd27e24c9eb433168d9c107a99d02",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 641970,
"upload_time": "2024-12-17T05:19:17",
"upload_time_iso_8601": "2024-12-17T05:19:17.034213Z",
"url": "https://files.pythonhosted.org/packages/1d/98/062d03109576f3dc5a27bb3a2a74bea9b59aa4ed5d2b9b12f98a15a09fd8/mkdocs_terminal-4.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "4.7.0",
"digests": {
"blake2b_256": "95410d4ab5fcee2030f4800f0925ccbc03531d44f89686ad07db83cf2fd77854",
"md5": "d3fc7fa92c98c07eba70effa16235f38",
"sha256": "9a8abcc560d66974a3fcfac9381167c7a3d52add1c30403b8cf35b3d2b10362e"
},
"downloads": -1,
"filename": "mkdocs_terminal-4.7.0.tar.gz",
"has_sig": false,
"md5_digest": "d3fc7fa92c98c07eba70effa16235f38",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 619993,
"upload_time": "2024-12-17T05:19:18",
"upload_time_iso_8601": "2024-12-17T05:19:18.725207Z",
"url": "https://files.pythonhosted.org/packages/95/41/0d4ab5fcee2030f4800f0925ccbc03531d44f89686ad07db83cf2fd77854/mkdocs_terminal-4.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-17 05:19:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ntno",
"github_project": "mkdocs-terminal",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "jinja2",
"specs": [
[
">=",
"2.10"
]
]
},
{
"name": "mkdocs",
"specs": [
[
">=",
"1.4.2"
]
]
},
{
"name": "markdown",
"specs": []
},
{
"name": "pygments",
"specs": []
},
{
"name": "pymdown-extensions",
"specs": []
}
],
"tox": true,
"lcname": "mkdocs-terminal"
}
JSON
