Skip to main content

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!");
}
```

Metadata

Release files for mkdocs-docslab 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-docslab 0.1.1
File Size Uploaded
mkdocs-docslab-0.1.1.tar.gz 2.5 kB Details

Release files / mkdocs-docslab-0.1.1.tar.gz

Download URL mkdocs-docslab-0.1.1.tar.gz
Size 2.5 kB
Tags Source
SHA-256 checksum
How to use checksums
11f1393e009602c9e9b1a404792f6f7b9a608b99b4d232af6c321af78520d938
BLAKE2b-256 checksum
How to use checksums
2d8eb33d3673ee5dbd34937474ccea2a75559d82e9800f047fd3c9c153efe182
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.11.4

Release history Release notifications | RSS feed

This release

0.1.1 This release

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page