Skip to content

Commit

Permalink
deploy: 82e2626
Browse files Browse the repository at this point in the history
  • Loading branch information
@rdmueller
rdmueller committed Nov 27, 2024
1 parent 37e8a2a commit 1fa0a55
Show file tree
Hide file tree
Showing 6 changed files with 350 additions and 83 deletions.
4 changes: 2 additions & 2 deletions feed.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
<atom:link href="http://jbake.org/feed.xml" rel="self" type="application/rss+xml" />
<description>JBake Bootstrap Template</description>
<language>en-gb</language>
<pubDate>Wed, 27 Nov 2024 10:35:25 +0000</pubDate>
<lastBuildDate>Wed, 27 Nov 2024 10:35:25 +0000</lastBuildDate>
<pubDate>Wed, 27 Nov 2024 10:37:34 +0000</pubDate>
<lastBuildDate>Wed, 27 Nov 2024 10:37:34 +0000</lastBuildDate>



Expand Down
28 changes: 14 additions & 14 deletions lunrjsindex.js
View file

Large diffs are not rendered by default.

191 changes: 163 additions & 28 deletions manual/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,7 @@
<li><a href="#_testing_guide">Testing Guide</a></li>
<li><a href="#_usage_guide">Usage Guide</a></li>
<li><a href="#_rule_reference">Rule Reference</a></li>
<li><a href="#_title">Title</a></li>
<li><a href="#_code">code</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -1312,67 +1312,203 @@ <h5 id="_head003_multiple_top_level_headings">HEAD003: Multiple Top-Level Headin
</div>
</div>
<div class="sect3">
<h4 id="_planned_rules">Planned Rules</h4>
<h4 id="_block_rules">Block Rules</h4>
<div class="sect4">
<h5 id="_block001_block_termination">BLOCK001: Block Termination</h5>
<div class="paragraph planned">
<p>Checks for properly terminated blocks.</p>
<div class="paragraph">
<p>Checks for properly terminated blocks in AsciiDoc files. This rule helps prevent incomplete or malformed block structures that could lead to incorrect rendering.</p>
</div>
<div class="ulist">
<div class="title">Supported Block Types</div>
<ul>
<li>
<p>Listing blocks (<code>----</code>)</p>
</li>
<li>
<p>Example blocks (<code>====</code>)</p>
</li>
<li>
<p>Sidebar blocks (<code><strong>*</strong>*</code>)</p>
</li>
<li>
<p>Literal blocks (<code>&#8230;&#8203;.</code>)</p>
</li>
<li>
<p>Quote blocks (<code><em>__</em></code>)</p>
</li>
<li>
<p>Table blocks (<code>|===</code>)</p>
</li>
<li>
<p>Comment blocks (<code>////</code>)</p>
</li>
<li>
<p>Passthrough blocks (<code></code>)</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="title">Valid Example</div>
<div class="content">
<pre class="prettyprint highlight"><code data-lang="asciidoc">[source,python]</code></pre>
<pre class="prettyprint highlight"><code data-lang="asciidoc">.Example Title
====
This is an example block.
It has proper opening and closing delimiters.
====</code></pre>
</div>
</div>
<div class="listingblock">
<div class="title">Invalid Example</div>
<div class="content">
<pre class="prettyprint highlight"><code data-lang="asciidoc">.Example Title
====
This block is not properly terminated.
More content...</code></pre>
</div>
</div>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 6. Configuration Options</caption>
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Option</th>
<th class="tableblock halign-left valign-top">Default</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">enabled</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Enable/disable rule</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">severity</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">error</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Rule severity level</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect4">
<h5 id="_block002_block_spacing">BLOCK002: Block Spacing</h5>
<div class="paragraph">
<p>def hello():
print("Hello")</p>
<p>Ensures proper spacing around blocks by checking for blank lines before and after block structures.</p>
</div>
<div class="olist arabic">
<div class="title">Rules</div>
<ol class="arabic">
<li>
<p>A blank line should precede a block (except when it follows a heading)</p>
</li>
<li>
<p>A blank line should follow a block (except when it&#8217;s followed by a heading)</p>
</li>
</ol>
</div>
<div class="listingblock">
<div class="title">Valid Example</div>
<div class="content">
<pre class="prettyprint highlight"><code data-lang="asciidoc">Some text before the block.</code></pre>
</div>
</div>
<div class="paragraph">
<p>Block content</p>
</div>
<div class="listingblock">
<div class="content">
<pre></pre>
<pre>More text after the block.</pre>
</div>
</div>
<div class="listingblock">
<div class="title">Invalid Example</div>
<div class="content">
<pre class="prettyprint highlight"><code data-lang="asciidoc">[source,python]</code></pre>
<pre class="prettyprint highlight"><code data-lang="asciidoc">Some text before the block.</code></pre>
</div>
</div>
<div class="paragraph">
<p>def hello():
print("Hello")
# Missing block termination</p>
<p>Block content</p>
</div>
<div class="listingblock">
<div class="content">
<pre>==== WS001: Whitespace

[.planned]
Ensures proper spacing around elements.

.Valid Example
[source,asciidoc]</pre>
</div>
<pre>More text after the block.</pre>
</div>
</div>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 7. Configuration Options</caption>
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Option</th>
<th class="tableblock halign-left valign-top">Default</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">enabled</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Enable/disable rule</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">severity</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">warning</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Rule severity level</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect2">
<h3 id="_title">Title</h3>
<div class="sect3">
<h4 id="_section">Section</h4>
<div class="paragraph">
<p>Some content.</p>
<h4 id="_planned_rules">Planned Rules</h4>
<div class="sect4">
<h5 id="_ws001_whitespace">WS001: Whitespace</h5>
<div class="paragraph planned">
<p>Ensures proper spacing around elements.</p>
</div>
<div class="listingblock">
<div class="title">Valid Example</div>
<div class="content">
<pre class="prettyprint highlight"><code>code</code></pre>
<pre class="prettyprint highlight"><code data-lang="asciidoc">== Title

=== Section

Some content.

[source]</code></pre>
</div>
</div>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_code">code</h3>
<div class="listingblock">
<div class="content">
<pre>=== Rule Development
<pre>==== TABLE001: Table Formatting

[.planned]
Ensures consistent table formatting.

==== IMG001: Image Attributes

[.planned]
Checks for required image attributes like alt text.

==== LINK001: Link Validation

[.planned]
Validates internal and external links.

=== Rule Development

==== Creating New Rules

Expand Down Expand Up @@ -1409,7 +1545,6 @@ <h4 id="_section">Section</h4>
</div>
</div>
</div>
</div>
</div>
</p>

Expand Down
2 changes: 1 addition & 1 deletion manual/rules.adoc.meta
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Documentation of all rules
Documentation of all linter rules
Loading

0 comments on commit 1fa0a55

Please sign in to comment.