Skip to content

Commit ef14936

Browse files
authored
Deployed 5dcaeca with MkDocs version: 1.6.0
1 parent 3b2d004 commit ef14936

2 files changed

Lines changed: 99 additions & 2 deletions

File tree

howto/use_jinja2/index.html

Lines changed: 98 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -473,6 +473,17 @@
473473

474474

475475

476+
<label class="md-nav__link md-nav__link--active" for="__toc">
477+
478+
479+
<span class="md-ellipsis">
480+
Using jinja2
481+
</span>
482+
483+
484+
<span class="md-nav__icon md-icon"></span>
485+
</label>
486+
476487
<a href="./" class="md-nav__link md-nav__link--active">
477488

478489

@@ -483,6 +494,34 @@
483494

484495
</a>
485496

497+
498+
499+
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
500+
501+
502+
503+
504+
505+
506+
<label class="md-nav__title" for="__toc">
507+
<span class="md-nav__icon md-icon"></span>
508+
Table of contents
509+
</label>
510+
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
511+
512+
<li class="md-nav__item">
513+
<a href="#indented-content-like-content-tabs" class="md-nav__link">
514+
<span class="md-ellipsis">
515+
Indented content like content tabs
516+
</span>
517+
</a>
518+
519+
</li>
520+
521+
</ul>
522+
523+
</nav>
524+
486525
</li>
487526

488527

@@ -598,6 +637,23 @@
598637

599638

600639

640+
<label class="md-nav__title" for="__toc">
641+
<span class="md-nav__icon md-icon"></span>
642+
Table of contents
643+
</label>
644+
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
645+
646+
<li class="md-nav__item">
647+
<a href="#indented-content-like-content-tabs" class="md-nav__link">
648+
<span class="md-ellipsis">
649+
Indented content like content tabs
650+
</span>
651+
</a>
652+
653+
</li>
654+
655+
</ul>
656+
601657
</nav>
602658
</div>
603659
</div>
@@ -629,6 +685,47 @@ <h1 id="using-jinja2">Using jinja2</h1>
629685

630686
{% endfor %}
631687
</code></pre></div>
688+
<h2 id="indented-content-like-content-tabs">Indented content like content tabs</h2>
689+
<p>If you inserted content has multiple lines, then indentation will be not be retained beyond the first line. This means things like <a href="https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#usage">content tabs</a> will not work as expected.</p>
690+
<p>To fix that, you can use the custom <em>filter</em> <code>add_indendation</code> (a filter add to <code>macros</code> by <code>table-reader</code> plugin). For example:</p>
691+
<div class="tabbed-set tabbed-alternate" data-tabs="1:2"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">index.md</label><label for="__tabbed_1_2">mkdocs.yml</label></div>
692+
<div class="tabbed-content">
693+
<div class="tabbed-block">
694+
<div class="highlight"><pre><span></span><code><span class="cp">{%</span> <span class="k">set</span> <span class="nv">table_names</span> <span class="o">=</span> <span class="o">[</span><span class="s2">&quot;basic_table.csv&quot;</span><span class="o">,</span><span class="s2">&quot;basic_table2.csv&quot;</span><span class="o">]</span> <span class="cp">%}</span>
695+
<span class="cp">{%</span> <span class="k">for</span> <span class="nv">table_name</span> <span class="k">in</span> <span class="nv">table_names</span> <span class="cp">%}</span>
696+
697+
<span class="x">=== &quot;</span><span class="cp">{{</span> <span class="nv">table_name</span> <span class="cp">}}</span><span class="x">&quot;</span>
698+
699+
<span class="x"> { { read_csv(table_name) | add_indentation(spaces=4) }}</span>
700+
701+
<span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span>
702+
</code></pre></div>
703+
</div>
704+
<div class="tabbed-block">
705+
<div class="highlight"><pre><span></span><code><span class="nt">site_name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">test git_table_reader site</span>
706+
<span class="nt">use_directory_urls</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
707+
708+
<span class="nt">theme</span><span class="p">:</span>
709+
<span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">material</span>
710+
711+
<span class="nt">plugins</span><span class="p">:</span>
712+
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">search</span>
713+
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">macros</span>
714+
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">table-reader</span>
715+
716+
<span class="nt">markdown_extensions</span><span class="p">:</span>
717+
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">pymdownx.superfences</span>
718+
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">pymdownx.tabbed</span><span class="p">:</span>
719+
<span class="w"> </span><span class="nt">alternate_style</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
720+
</code></pre></div>
721+
</div>
722+
</div>
723+
</div>
724+
<div class="admonition note">
725+
<p class="admonition-title">Note the space in { {</p>
726+
<p>To avoid the tables being inserted into the code example, we replaced <code>{{</code> with <code>{ {</code>.
727+
If you copy this example, make sure to fix.</p>
728+
</div>
632729

633730

634731

@@ -649,7 +746,7 @@ <h1 id="using-jinja2">Using jinja2</h1>
649746
<span class="md-icon" title="Last update">
650747
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
651748
</span>
652-
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2024-08-15T13:55:15+02:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-08-15</span>
749+
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2024-08-15T15:49:57+02:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-08-15</span>
653750
</span>
654751

655752

0 commit comments

Comments
 (0)