Browse Source

Improve Better Tables plugin ReadMe

Justin Mayer 8 years ago
parent
commit
b7333cba54
1 changed files with 16 additions and 18 deletions
  1. 16 18
      better_tables/README.md

+ 16 - 18
better_tables/README.md

@@ -1,16 +1,16 @@
 # Better Tables
 
-This pelican plugin removes the excess attributes and elements in the HTML
-tables generated from RST. Trimming this fat allows them to pass HTML5
-validation. Hopefully rst2html5 will be merged into pelican at some point, but
+This Pelican plugin removes the excess attributes and elements in the HTML
+tables generated from reST. Trimming this fat allows them to pass HTML5
+validation. Hopefully `rst2html5` will be merged into Pelican at some point, but
 until then, this hacky approach is needed.
 
 This approach has the advantage of restoring sanity to tables, and allows their
-column with to flow normally. All styling is default and must be styled by CSS
+column width to flow normally. All styling is default and must be styled by CSS
 rather than in HTML attributes.
 
-I make no claim that /all/ HTML table crimes generated are corrected, merely
-the ones which I have stumbled across.
+I make no claim that **all** HTML table crimes generated are corrected — merely
+the ones that I have stumbled across.
 
 ## Requirements
 
@@ -19,22 +19,20 @@ the ones which I have stumbled across.
 ## What does it do?
 
 At the moment, the following is stripped from tables (though when in doubt,
-check the source as it may be updated out of sync with this document).
+check the source as it may be updated and out-of-sync with this document).
 
-* <colgroup> element (and its evil <col> children)
-* table's "border" attribute
-* <tbody> and <thead>'s valign attribute
+* `<colgroup>` element (and its evil `<col>` children)
+* `table` > `border` attribute
+* `<tbody>` and `<thead>` > `valign` attribute
 
 ## Usage
 
-Enable the plugin in your pelicanconf.py
+Enable the plugin in your pelicanconf.py:
 
-```
-PLUGINS = [
-    # ...
-    'better_tables',
-    # ...
-]
-```
+    PLUGINS = [
+        # ...
+        'better_tables',
+        # ...
+    ]
 
 And that's it. Life's simple like that sometimes.