runme
id version 01HXCP9T32MB8P6770TB4EC4TF v3

Mkdocs Runme Plugin

Features:

1. Automatically Creates Badge for Runme
2. Secures Fenced Code Blocks for flawless rendering

Setup

Virtual Environment (venv)

To create a virtual environment for your Mkdocs project, you can follow these steps:

1. Open a terminal or command prompt.
2. Navigate to your project directory:
3. Create a new virtual environment:

python3 -m venv venv

4. Activate the virtual environment:

• On macOS and Linux:

source venv/bin/activate

• On Windows:

venv\Scripts\activate

5. Install the required packages:

pip install -r requirements.txt

6. Now you can proceed with running the Mkdocs server or building the documentation.
7. When you're done, you can deactivate the virtual environment:

deactivate

That's it! You have successfully set up a virtual environment for your Mkdocs project.

Installing

Install python module

pip install git+https://github.com/stateful/mkdocs-runme-plugin.git

Configuration

plugins:
  - runme:
      # Repository URL for generated badges
      repository: https://github.com/stateful/mkdocs-runme-plugin.git
      # Docs Directory to generate the badge link, defaults to docs
      docs_dir: workflows