@xiee/utils 1.1.4 → 1.1.7

package/README.md

@@ -58,6 +58,13 @@ to render unique `id`s for the footnote items (the `id` is `fn:-`).
 
 Fix the table of contents generated by lower versions of Hugo.
 
+## hash-notes.js
+
+Convert HTML comments of the form `<!--# comments -->` to
+`<span class="hash-note">comments</span>`. If such comments are found, the
+document body will gain classes `has-notes` and `hide-notes`. You can use CSS to
+style the notes or hide/show them as you wish.
+
 ## header-link.js
 
 Add anchor links to all section headers (e.g., `<h2>`) that have nonempty `id`

package/css/faq.css

@@ -4,6 +4,9 @@
 .faq-list > li > :first-child {
   display: block;
   cursor: pointer;
+  background: #fafafa;
+  margin: -.5em;
+  padding: .5em;
 }
 .faq-list > :not(.faq-clicked) > * {
   display: none;
@@ -20,11 +23,5 @@
 }
 .faq-list > li {
   border: 1px solid #eee;
-}
-.faq-list > li > :first-child {
-  background: #fafafa;
-  margin: 0;
-}
-.faq-list > li > * {
   padding: .5em;
 }

package/js/fix-footnote.js

@@ -1,6 +1,6 @@
-(function() {
+(function(d) {
   function fix_footnote(tagName) {
-    var tags = document.getElementsByTagName(tagName), i, tag, tag2, n = 1, href;
+    let tags = d.getElementsByTagName(tagName), i, tag, tag2, n = 1, href;
     for (i = 0; i < tags.length; i++) {
       tag = tags[i];
       if (tagName === 'sup') {
@@ -25,4 +25,8 @@
     }
   }
   fix_footnote('sup'); fix_footnote('li');
-})();
+  // move the return symbol into the previous <p>
+  d.querySelectorAll('.footnotes > ol > li > p ~ .footnote-return').forEach(el => {
+    el.previousElementSibling.lastChild.after(el);
+  });
+})(document);

package/js/hash-notes.js

@@ -0,0 +1,23 @@
+// convert <!--# comments --> to <span class="hash-notes">comments</span>
+(function(d) {
+  function toSpan(el) {
+    const t = el.textContent, r = /^#[\s\n]+([\s\S]+)[\s\n]+$/;
+    if (!r.test(t)) return;
+    d.body.classList.add('has-notes', 'hide-notes');
+    // use <p> if the comment's parent is not <p>; otherwise use inline <span>
+    const s = d.createElement(el.parentNode.nodeName === 'P' ? 'span' : 'p');
+    s.className = 'hash-note';
+    s.innerText = t.replace(r, '$1');
+    s.innerHTML = s.innerHTML
+      .replace(/\[([^\]]+)\]\(([^)]+)\)/g, '<a href="$2" target="_blank">$1</a>')
+      .replace(/(^|[^"])(https?:\/\/)([-a-zA-Z0-9%._=/\+]+)(#)?([-a-zA-Z0-9%._=\+]+)?/g, '$1<a href="$2$3$4$5" target="_blank">$3$4</a>');
+    el.before(s);
+    el.remove();
+  };
+  function findComments(el) {
+    el.childNodes.forEach(node => {
+      node.nodeType === Node.COMMENT_NODE ? toSpan(node) : findComments(node);
+    });
+  };
+  findComments(d.body);
+})(document);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xiee/utils",
-  "version": "1.1.4",
+  "version": "1.1.7",
   "description": "Miscellaneous tools and utilities to manipulate HTML pages",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"