Skip to main content

Enable user defined values for MkDocs

Project description

mkdocs-user-defined-values

This is a plugin for a MkDocs which allows pages to have user defined input values.

Setup

Install the plugin using pip:

pip install mkdocs-user-defined-values

Activate the plugin in mkdocs.yml:

plugins:
  - search
  - user-defined-values:
      keywords:
        AWS_REGION:
          placeholder: ap-southeast-2
        AWS_ACCOUNT:

Note: If you have no plugins entry in your config file yet, you'll likely also want to add the search plugin. MkDocs enables it by default if there is no plugins entry set, but now you have to enable it explicitly.

More information about plugins in the MkDocs documentation.

Config

  • keywords - This is a list of keywords which you want to allow a user to modify.
  • input-placeholder - This is a placeholder where you want the plugin to generate the form for user to provide dynamic values for each keyword. Default value is {{{user-defined-values}}}.

Usage

  • Provide a list of keywords you want a user to provide dynamically.
  • Place {{{user-defined-values}}} in your page or template where you want to generate the form for user to provide dynamic values.

See Also

More information about templates here.

More information about blocks here.

Project details


Download files

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

Files for mkdocs-user-defined-values, version 0.0.4
Filename, size File type Python version Upload date Hashes
Filename, size mkdocs-user-defined-values-0.0.4.tar.gz (3.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page