html_toc 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50bdad061fab78d122148441df6c9f3f8bc5d7d5
-  data.tar.gz: 8dbfed1fa805e85baecf951a1dbb3a5225fd32b9
+  metadata.gz: 7fe0bd1ed85bd6019fdc3989a0f54f8bfb9d1560
+  data.tar.gz: 0e172e14bc8e9422d117a203451c4ce71363eab2
 SHA512:
-  metadata.gz: fe1196c22878e76b5becc41653b47a73892473594300874c78eb9533dd3a32554d6c56d1e75e46773bde69239f87aa1353256ca7aa5cd3634d46f98dca8eb6c7
-  data.tar.gz: c93958e602fce4406ad2bc8bd71f07f80978b8af103c5e8d33d9cc8672091d17f87e3f9b34c08c4e83831650fb1efdf0828f3d25936fedc68ad9e9a6c8c0d64a
+  metadata.gz: 4717de16883ae3c3100b75e1c41e536c5b7b5d71017eb9099844c12cca80cd72e3fc331a42d4b41dc85028871fb96687df8ca79bab324df1242f489026d80dab
+  data.tar.gz: d71ebf5f843cde92e66e270638d6bd365fb638f2d4296adafa2ca56ecc8d177201cce3b81772155d9b804d18ce90ab995324cbbb2b5f2400002f3936d3caa69b

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: html_toc
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Gregory Gadow
@@ -10,11 +10,17 @@ bindir: bin
 cert_chain: []
 date: 2014-12-09 00:00:00.000000000 Z
 dependencies: []
-description: Do a case-insensitive search on an HTML document for the token [[toc]].
-  If present, scan the document for header tags in a given range, verify that they
-  have an id attribute and give them one if needed, then generate a group of links
-  pointing to those headers with the header text used as the link text. This group
-  of links then replaces the token.
+description: "This gem is intended to be used in Rails pre-processing, after the page
+  has been generated but before it is delivered to the requestor. \n\nIt does a case-insensitive
+  search in the source text for [[toc]], which marks where the table of contents will
+  be placed. If the token is not found, the unmodified source is returned.\n\nIf the
+  token is found, it searches the text for header tags in a given range, and add an
+  id attribute if the header does not already have one. If no headers were found,
+  it will remove the token and return the modified source. \n\nIf there are headers,
+  a link is generated for each one, using the header's text and id for the link's
+  text and href. The links are wrapped in some divs, with classes and ids added so
+  the table of contents can be styled. The token is then replaced with the table of
+  contents, and the the modified source is returned.\n"
 email: gpg@gregory-gadow.net
 executables: []
 extensions: []