Skip to content

Tweaked the configuration block directive #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 26, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
<div class="configuration-block">
<ul class="simple">
<ul class="configuration-tabs">
{% for block in blocks %}
<li>
<em>{{ block.language }}</em>
{{ block.code|raw }}
<li data-language="{{ block.language }}" {{ loop.first ? 'data-active="true"' }}>
<span>{{ block.language }}</span>
</li>
{% endfor %}
</ul>

{% for block in blocks %}
<div class="configuration-codeblock" data-language="{{ block.language }}" style="{{ not loop.first ? 'display: none' }}">
{{ block.code|raw }}
</div>
{% endfor %}
37 changes: 18 additions & 19 deletions tests/fixtures/expected/blocks/directives/configuration-block.html
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
<div class="configuration-block">
<ul class="simple">
<li>
<em>YAML</em>
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-yaml">
<div class="codeblock-scroll">
<pre class="codeblock-lines">1</pre>
<pre class="codeblock-code"><code><span class="hljs-comment"># app/config/services.yml</span>
</code></pre>
<ul class="configuration-tabs">
<li data-language="YAML" data-active="true"> <span>YAML</span> </li>
<li data-language="PHP" > <span>PHP</span> </li>
</ul>
<div class="configuration-codeblock" data-language="YAML" style="">
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-yaml">
<div class="codeblock-scroll">
<pre class="codeblock-lines">1</pre>
<pre class="codeblock-code"><code><span class="hljs-comment"># app/config/services.yml</span></code></pre>
</div>
</div>
</div>
</div>
</li>
<li>
<em>PHP</em>
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-php">
<div class="codeblock-scroll">
<pre class="codeblock-lines">1</pre>
<pre class="codeblock-code"><code><span class="hljs-comment">// config/routes.php</span>
</code></pre>
<div class="configuration-codeblock" data-language="PHP" style="display: none">
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-php">
<div class="codeblock-scroll">
<pre class="codeblock-lines">1</pre>
<pre class="codeblock-code"><code><span class="hljs-comment">// config/routes.php</span></code></pre>
</div>
</div>
</div>
</div>
</li>
</ul></div>
29 changes: 15 additions & 14 deletions tests/fixtures/expected/main/datetime.html
Original file line number Diff line number Diff line change
Expand Up @@ -190,10 +190,13 @@ <h3 id="error-bubbling"><a class="headerlink" href="#error-bubbling" title="Perm
</div>
<p>And configuration blocks:</p>
<div class="configuration-block">
<ul class="simple">
<li>
<em>YAML</em>
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-yaml">
<ul class="configuration-tabs">
<li data-language="YAML" data-active="true"> <span>YAML</span> </li>
<li data-language="XML" > <span>XML</span> </li>
<li data-language="PHP" > <span>PHP</span> </li>
Copy link
Contributor

@OskarStark OskarStark Mar 25, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-        <li data-language="PHP" > <span>PHP</span> </li>
+        <li data-language="PHP"><span>PHP</span></li>

Do we really need to generate these spaces?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd prefer to keep it (it's the same case as https://github.com/weaverryan/docs-builder/pull/56#issuecomment-791463260).

I know some people disagree but ... I prefer to make templates readable instead of making the generated HTML perfect, because templates are for humans (and they must maintain them in the future) and HTML is for machines and they don't care.

I hope you agree somewhat on this 🙏

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 to be pragmatic on this kind of things

</ul>
<div class="configuration-codeblock" data-language="YAML" style="">
<div translate="no" class="notranslate codeblock codeblock-loc-1 codeblock-yaml">
<div class="codeblock-scroll">
<pre class="codeblock-lines">1
2
Expand All @@ -212,10 +215,9 @@ <h3 id="error-bubbling"><a class="headerlink" href="#error-bubbling" title="Perm
</code></pre>
</div>
</div>
</li>
<li>
<em>XML</em>
<div translate="no" class="notranslate codeblock codeblock-loc-2 codeblock-xml">
</div>
<div class="configuration-codeblock" data-language="XML" style="display: none">
<div translate="no" class="notranslate codeblock codeblock-loc-2 codeblock-xml">
<div class="codeblock-scroll">
<pre class="codeblock-lines">1
2
Expand Down Expand Up @@ -260,10 +262,9 @@ <h3 id="error-bubbling"><a class="headerlink" href="#error-bubbling" title="Perm
</code></pre>
</div>
</div>
</li>
<li>
<em>PHP</em>
<div translate="no" class="notranslate codeblock codeblock-loc-2 codeblock-php">
</div>
<div class="configuration-codeblock" data-language="PHP" style="display: none">
<div translate="no" class="notranslate codeblock codeblock-loc-2 codeblock-php">
<div class="codeblock-scroll">
<pre class="codeblock-lines">1
2
Expand All @@ -288,8 +289,8 @@ <h3 id="error-bubbling"><a class="headerlink" href="#error-bubbling" title="Perm
</code></pre>
</div>
</div>
</li>
</ul></div>
</div>
</div>
</div>
</div>
<div class="section">
Expand Down