mkdocs-terminal 4.5.0

Terminal.css theme for MkDocs

mkdocs-terminal

Terminal for MkDocs is a third party theme that brings the Terminal.css stylesheet to MkDocs documentation sites.

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:

pip install mkdocs-terminal

Add the following lines to mkdocs.yml:

theme:
  name: terminal

Documentation

mkdocs-terminal docs

Developer Info

Terminal for MkDocs on GitHub
Terminal for MkDocs on PyPI
Theme Development README

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.