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

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.1.tar.gz (2.5 kB view details)

Uploaded Source

File details

Details for the file mkdocs-docslab-0.1.1.tar.gz.

File metadata

  • Download URL: mkdocs-docslab-0.1.1.tar.gz
  • Upload date:
  • Size: 2.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.4

File hashes

Hashes for mkdocs-docslab-0.1.1.tar.gz
Algorithm Hash digest
SHA256 11f1393e009602c9e9b1a404792f6f7b9a608b99b4d232af6c321af78520d938
MD5 8256489d89c6e1f102daeec304fb0f37
BLAKE2b-256 2d8eb33d3673ee5dbd34937474ccea2a75559d82e9800f047fd3c9c153efe182

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.1 This release

1 file

0.1.0

1 file

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page