MkDocs plugin for interactive code
Project description
This MkDocs plugin uses docslab to make code blocks interactive.
First, install it from PyPI:
pip install mkdocs-docslab
Then, add it to your mkdocs.yml file.
plugins:
- docslab
To make a code block interactive, add docslab to the meta string, e.g.,
```{ .cpp .docslab } // hardshare=heliumdev/cubecell-draw-demo // command: source .platformio/penv/bin/activate && cd m/Heltec-CubeCell-Board/examples/cubecell-helium-us915-basic && pio run -t upload && pio device monitor // destpath: m/Heltec-CubeCell-Board/examples/cubecell-helium-us915-basic/src/main.cpp // repoUrl: https://github.com/helium/longfi-platformio.git // --- #include "Arduino.h" void setup() { Serial.begin(115200); } void loop() { delay(1000); Serial.println("Hola, mundo!"); } ```
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
mkdocs-docslab-0.1.0.tar.gz
(2.6 kB
view details)
File details
Details for the file mkdocs-docslab-0.1.0.tar.gz
.
File metadata
- Download URL: mkdocs-docslab-0.1.0.tar.gz
- Upload date:
- Size: 2.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.11.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 99350cc8d11b5187d3f1f125d84dbe31a0fb1f5e7a52732ece045d115b6a09c3 |
|
MD5 | c823492371e7b0c116470fc5cab65fb1 |
|
BLAKE2b-256 | 14a67960824f53162fa802aa3807f28be58fd09685d61a3cfef6a75bd3e0fbe7 |