Skip to main content

mkdocs-command-generator

This MkDocs plugin allows you to create tables with commands that can be easily copied by users. You can define the commands in a simple markdown format, and the plugin will generate a theme-compatible table with code snippets.

The formula for defining commands is as follows:

  • In your markdown file use the --cmd-gen<-- and -->cmd-gen-- markers to indicate the start and end of the command definitions.
  • Each command definition should be on a new line and follow the format:
    - <row-1>,<row-2>,...:
      <command-1>
      <command-2>
      ...
    
    where <row-1>,<row-2>,... are the labels for the rows in the table, and <command-1>, <command-2>, etc. are the commands that will be displayed in the corresponding cells of the table.
  • You don't need to specify all possible combinations of rows. The plugin will automatically generate "This configuration is not supported." for any missing combinations.
--cmd-gen<--
- v7x (Ironwood),Gemma4:
  gcloud container node-pools create ${NODEPOOL_NAME} \
    --project=${PROJECT_ID} \
    --machine-type=tpu7x-standard-4t \
    ...
- v7x (Ironwood),GPT-OSS:
  gcloud container node-pools create ${NODEPOOL_NAME} \
    --project=${PROJECT_ID} \
    --model=openai/gpt-oss-120b
    ...
- v6e (Trillium),Llama3.x:
  gcloud alpha compute tpus tpu-vm create $TPU_NAME \
    --type v6e --topology 2x4 \
    --project $PROJECT --zone $ZONE --version v2-alpha-tpuv6e
  vllm serve meta-llama/Llama-3.3-70B-Instruct
- v6e (Trillium),Gemma4:
  gcloud alpha compute tpus tpu-vm create $TPU_NAME \
    --type v6e --topology 2x4 \
    --project $PROJECT --zone $ZONE --version v2-alpha-tpuv6e
  vllm serve google/gemma-4-31B-it
-->cmd-gen--

Metadata

Release files for mkdocs-command-generator 0.1.2

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

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-command-generator 0.1.2
File Interpreter ABI Platform
mkdocs_command_generator-0.1.2-py3-none-any.whl Python 3 none any Details

Release files / mkdocs_command_generator-0.1.2-py3-none-any.whl

Download URL mkdocs_command_generator-0.1.2-py3-none-any.whl
Size 5.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ee99419c2c051ebdf9cf00c7dd1963d81e420a24b06f20aea9fdc6df3a5bafb8
BLAKE2b-256 checksum
How to use checksums
ba5a71fcd18d36890bafa18c7e8a6097f72614f426a443cf957b68a80928c257
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.13

Release history Release notifications | RSS feed

This release

0.1.2 This release

1 release file

0.1.1

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