Skip to content

Commit

Permalink
Fix warning messages on build from mkdocs-macros (#351)
Browse files Browse the repository at this point in the history
  • Loading branch information
athackst committed Jul 28, 2022
1 parent 733fbed commit 547d9ba
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 14 deletions.
19 changes: 9 additions & 10 deletions examples/ok-with-macros/example.grepout
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
<h1 id="example">Example</h1>
<p>Here's a printout of the plugin's config file, which I've included using a jinja-style macro.</p>
<pre><code class="language-yaml">
# You can even use this with other plugins, like
# [macros](https://pypi.org/project/mkdocs-macros-plugin/) to achieve advanced
# configurations.
site_name: ok-with-macros
docs_dir: /tmp/mkdocs-simple/ok-with-macros/docs
plugins:
- search
- simple:
include_extensions:
- &quot;.yml&quot;
- macros:
verbose: True
- search
- simple:
include_extensions:
- .yml
- macros:
verbose: true
edit_uri: ''
site_url: http://localhost
extra:
test: True
test: true

</code></pre></div>
3 changes: 1 addition & 2 deletions examples/ok-with-macros/example.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ Here's a printout of the plugin's config file, which I've included using a jinja

`````yaml
{% if test %}
{% include "mkdocs-test.yml" %}
{% else %}{% include "examples/ok-with-macros/mkdocs-test.yml" %}
{% include "mkdocs.yml" %}
{% endif %}
`````
4 changes: 3 additions & 1 deletion examples/ok-with-macros/module.grepout
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
<p>You can put <em>markdown</em> in triple-quoted strings in Python.</p>
<p>You can even use macros to inject other markdown here!</p>
<p>For example, here's the config file:</p>
<pre><code class="language-yaml">site_name: ok-with-macros
<pre><code class="language-yaml">
site_name: ok-with-macros
docs_dir: /tmp/mkdocs-simple/ok-with-macros/docs
plugins:
- search
Expand All @@ -15,4 +16,5 @@ edit_uri: ''
site_url: http://localhost
extra:
test: true

</code></pre></div>
4 changes: 3 additions & 1 deletion examples/ok-with-macros/module.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@
For example, here's the config file:
````yaml
{% include 'mkdocs.yml' %}
{% if test %}
{% include "mkdocs.yml" %}
{% endif %}
````
"""

Expand Down

0 comments on commit 547d9ba

Please sign in to comment.