A MKDocs plugin which extends the material theme with styles from the VA design system
Project description
Material VA Lighthouse Plugin
This plugin styles a Material for MKDocs site using CSS from the VA Design System.
Installation
Open a terminal and run the following command:
pip install material-va-lighthouse
Or add the following to your requirements.txt
file:
material-va-lighthouse
Update your mkdocs.yml
to include the plugin:
plugins:
- material-va-lighthouse
Update the theme
section. Set material
as your theme (if you're not already)
and point the logo to the Lighthouse logo from this plugin:
theme:
name: material
logo: 'assets/images/va_lighthouse_logo.png'
Then add an extra_css
section to your mkdocs.yml
that points to the CSS file from this plugin:
theme:
name: material
logo: 'assets/images/va_lighthouse_logo.png'
extra_css:
- 'assets/stylesheets/va_lighthouse.css'
Run mkdocs build
and mkdocs serve
to see the changes.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for material-va-lighthouse-1.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 662330201fcd9beb7104ca08afe5a905ff879525f988618cb43d04393b621611 |
|
MD5 | fe7848723175f1cf280aace36aac87b9 |
|
BLAKE2b-256 | 6822a5ff4d519584cf95d9d808bb9e57c86ea770d4b22f3ec228f164d4b35a47 |
Close
Hashes for material_va_lighthouse-1.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cfdb805c4c23c82b3a625bdd0bc16f58f49404132db89ec30d9a7fb797f06520 |
|
MD5 | 5aac82b40fe55a41e6fa363438f347fb |
|
BLAKE2b-256 | 7df5e8b8897446c858c2a2a1877a5ec995daaf305599d4b72d29e5d9480772af |