up

Author: geraldb

index.md

@@ -19,5 +19,5 @@ More Book Examples:
 
 Markdown Tools:
 
-- [**Markdown Lint Rules / Style Checker**](http://manuscripts.github.io/markdown-lint) by Mark Harrison   - [Text in Manuscripts](https://github.com/manuscript/markdown-lint)
+- [**Markdown Lint Rules / Style Checker**](http://manuscripts.github.io/markdown-lint) by Mark Harrison   - [Text in Manuscripts](https://github.com/manuscripts/markdown-lint)
 

markdown-lint.html

@@ -0,0 +1,124 @@
+---
+layout: default
+title:  Markdown Lint Tool Documentation
+---
+
+{% assign book           = site.data.markdown_lint.book %}
+<!-- todo: check - can we use book.contents - why? why not? -->
+{% assign book_contents  = site.data.markdown_lint.contents %}
+
+
+<!-- cover -->
+
+<h1>{{ book.title }}</h1>
+<h3>by {{ book.author.name }}</h3>
+
+<!-- fix: use book.subtitle -->
+<p>A tool to check markdown files and flag style issues</p>
+
+<!-- table of contents -->
+
+<div class='toc'>
+
+Contents
+
+<ul>
+{% for part in book_contents %}
+  <li>{{ part.title }}
+   <ul>
+     {% for chapter in part.sections %}
+       <li>{{ chapter.title }}</li>
+     {% endfor %}
+   </ul>
+  </li>
+{% endfor %}
+</ul>
+</div>
+
+
+<h2>Preface</h1>
+
+<p>
+<b>Note:</b> The book edition is still an early release and a work-in-progess.
+</p>
+
+<p>
+This is the <a href="https://github.com/mivok/markdownlint">official documentation</a>
+for the markdown lint style rules checker
+reformatted in a single-page book edition.
+</p>
+
+<p>
+See the <a href="https://github.com/manuscripts/manuscripts.github.io">source repo</a> for how
+the book gets auto-built with a static site builder and hosted on GitHub Pages.
+</p>
+
+
+<p>
+Questions? Comments?
+Send them along to the
+<a href="http://groups.google.com/group/wwwmake">wwwmake mailing list/forum</a>
+Thanks.
+</p>
+
+<p>
+Onwards.
+</p>
+
+
+<h2>Acknowledgments</h2>
+
+<p>
+Thanks to Mark Harrison and contributors for making it all possible.
+</p>
+
+
+<!-- chapters -->
+
+{% for part in book_contents %}
+  <h1 class="part">Part {{ forloop.index }} - {{ part.title }}</h1>
+  
+  {% assign part_index = forloop.index %} 
+  {% for chapter in part.sections %}
+<div class="chapter">
+  <h1>Chapter {{ part_index }}.{{ forloop.index }} - {{ chapter.title }}</h1>
+            
+  <!-- add mini table of contents for chapter if available -->      
+  {% if chapter.sections %}
+  Contents
+  <ul>
+    {% for sec in chapter.sections %}
+    <li>{{ sec.title }}
+      {% if sec.sections %}
+        <ul>
+         {% for subsec in sec.sections %}
+           <li>{{ subsec.title }}</li>
+         {% endfor %}
+        </ul>
+      {% endif %}
+    </li>
+    {% endfor %}
+  </ul>
+  {% endif %}
+
+  <!-- try adding content using include_relative -->
+  {% capture txt %}{% include_relative _markdown-lint/{{chapter.path}} %}{% endcapture %}
+
+  <!-- hack: cut off yaml front matter header 
+     possible alternative??:
+       try to use collection and use a content lookup with title or path - why? whynot??
+    -->
+  {% assign txt_head = txt | truncate: 10 %}
+  <!-- note: allow files without front matter -->
+  {% if txt_head contains '---' %}
+    {% assign txt_ary = txt | replace_first: '---', '' | replace_first: '---', '@@END@@' | split: '@@END@@' %}  
+    {% assign txt2 = txt_ary[1] %}
+  {% else %}
+    {% assign txt2 = txt %}
+  {% endif %}
+
+  {{ txt2 | markdownify }}
+</div>
+  {% endfor %}
+
+{% endfor %}