Merge pull request #2 from janaz:mkdocs-1.1

Support mkdocs v1.1

Author: rahult

Pipfile

@@ -6,9 +6,13 @@ verify_ssl = true
 [dev-packages]
 pipenv-setup = "*"
 pylint = "*"
+black = "*"
 
 [packages]
 mkdocs = "*"
 
 [requires]
-python_version = "3.7"
+python_version = "3.8"
+
+[pipenv]
+allow_prereleases = true

Pipfile.lock

@@ -15,8 +15,10 @@ plugins:
   - search
   - user-defined-values:
       keywords:
-        - DOC_AS_CODE_PATH
-        - DOC_AS_CODE_VERSION
+        YOUR_AWS_REGION:
+          placeholder: e.g. ap-southeast-2
+        YOUR_AWS_ACCOUNT_ID:
+          placeholder: e.g. 12355224536
 ```
 
 > **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.
@@ -25,13 +27,20 @@ More information about plugins in the [MkDocs documentation][mkdocs-plugins].
 
 ## 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}}}`.
+- `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.
+- 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.
+
+## Demo/Test
+
+```bash
+cd demo
+pipenv run mkdocs serve
+```
 
 ## See Also
 
@@ -41,4 +50,4 @@ More information about blocks [here][mkdocs-block].
 
 [mkdocs-plugins]: http://www.mkdocs.org/user-guide/plugins/
 [mkdocs-template]: https://www.mkdocs.org/user-guide/custom-themes/#template-variables
-[mkdocs-block]: https://www.mkdocs.org/user-guide/styling-your-docs/#overriding-template-blocks
+[mkdocs-block]: https://www.mkdocs.org/user-guide/styling-your-docs/#overriding-template-blocks

README.md

@@ -0,0 +1,12 @@
+[[source]]
+name = "pypi"
+url = "https://pypi.org/simple"
+verify_ssl = true
+
+[dev-packages]
+
+[packages]
+mkdocs-user-defined-values = {editable = true,path = ".."}
+
+[requires]
+python_version = "3.8"

demo/Pipfile

@@ -0,0 +1,13 @@
+---
+title: Page with Plugin
+---
+
+# Page with Plugin
+
+{{{user-defined-values}}}
+
+### List ec2 instances for a region
+
+```
+aws ec2 describe-instances --output table --region YOUR_AWS_REGION
+```

demo/Pipfile.lock

@@ -0,0 +1,11 @@
+---
+title: Page without Plugin
+---
+
+# Page without Plugin
+
+### List ec2 instances for a region
+
+```
+aws ec2 describe-instances --output table --region YOUR_AWS_REGION
+```

demo/docs/page_with_plugin.md

@@ -0,0 +1,9 @@
+site_name: "Demo Test"
+use_directory_urls: false
+
+plugins:
+  - search
+  - user-defined-values:
+      keywords:
+        YOUR_AWS_REGION:
+          placeholder: e.g. ap-southeast-2

demo/docs/page_without_plugin.md

@@ -6,7 +6,7 @@ class UserDefinedValues(BasePlugin):
 
     config_scheme = (
         ('keywords', config_options.Type(dict)),
-        ('input-placeholder', config_options.Type(mkdocs_utils.string_types, default='{{{user-defined-values}}}'))
+        ('input-placeholder', config_options.Type(str, default='{{{user-defined-values}}}'))
     )
 
     def on_config(self, config, **kwards):
@@ -74,4 +74,4 @@ def on_post_page(self, output_content, page, config):
 
         output_content = output_content.replace(self.config['input-placeholder'], input_boxes)
 
-        return output_content
+        return output_content