Skip to main content

MkDocs plugin for command generating tables.

Project description

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--

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkdocs_command_generator-0.1.2-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_command_generator-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_command_generator-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ee99419c2c051ebdf9cf00c7dd1963d81e420a24b06f20aea9fdc6df3a5bafb8
MD5 28407e8ffd855319355d5be5b7bf9bce
BLAKE2b-256 ba5a71fcd18d36890bafa18c7e8a6097f72614f426a443cf957b68a80928c257

See more details on using hashes here.

Supported by

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