BLOGGER 【TOC】記事内もくじを自動で作成する

 BLOGGER用 TOC

JetThemeには、デフォルトで見出しを使った目次がついているのですが、そのためだけにテーマを入れ替えるのもなぁ……と思って、同じように自動でもくじが作成できるコードがないかな、と調べてみました!

スケ郎のお話さんのこちらの記事が分かりやすく、参考になりました!
(ありがとうございます!)

実際にやってみました!

手順1:HTMLを編集するのでバックアップをとる

テーマ→カスタマイズ横のメニューからバックアップを選択

簡単です!
ファイル名を分かりやすく変更したりして管理します

手順2:HTMLに直接コードをコピペする(終了)

★こちらのコードはスケ郎のお話さん作です
以下のソースコードをHTMLの/head>の前にペーストするだけ!
保存して公開済みの記事を見るとしっかりもくじができていました!
簡単!! ありがたすぎますね!
<!-- [START] 目次作成プラグイン-->
<b:if cond='data:blog.pageType == "item"'>
  <script>
    //以下のオプションを好みに合わせて変更して下さい
    //オプションの詳しい説明は、(https://www.sukerou.com/2018/10/blogger-table-of-contents-javascript.html)を参照
    var toc_options = {
      target: ["h2", "h3", "h4"],
      autoNumber:  true,
      condTargetCount: 2,
      insertPosition: "firstHeadBefore",
      showToc: true,
      width: "auto",
      marginTop: "20px",
      marginBottom: "20px",
      indent: "20px",
      postBodySelector: ".widget.Blog"
    };

    //これ以降のソースは編集しないでください
    ;(function (window) { var id_seq= 0; document.addEventListener(&apos;DOMContentLoaded&apos;, function () { var rootElement= document.querySelector(toc_options.postBodySelector); if (rootElement== null || typeof rootElement=== &quot;undefined&quot;) { return;} if (toc_options.target.length== 0) return; rootContent= searchHeadLine(toc_options, rootElement); if (rootContent.children.length &gt;= toc_options.condTargetCount) { var wrap= createElement(rootContent); appendElement(wrap);}}); function searchHeadLine(toc_options, rootElement) { var count= toc_options.target.length; var fn= function (index, element, parentContent) { var currentTarget= toc_options.target[index]; var nextTarget= index &lt; count - 1 ? toc_options.target[index + 1] : &quot;&quot;; var id= &quot;toc_headline_&quot; + (++id_seq); var content= createItem(currentTarget, text(element), index + 1, id); parentContent.children.push(content); element.id= id; var el= next(element); if (nextTarget== &quot;&quot;) { return;} var prevTarget= &quot;&quot;; for(var i= index; i &gt;= 0; i--) { prevTarget += (toc_options.target[i] + &quot;,&quot;);} while (true) { if (el== null || typeof el=== &quot;undefined&quot;) break; if (tagName(el)== currentTarget) break; if (tagName(el)== nextTarget) { fn(index + 1, el, content);} else { var nextElements= el.querySelectorAll(prevTarget + nextTarget); var breakFlg= false; for (var i= 0; i &lt; nextElements.length; i++) { if (tagName(nextElements[i]) != nextTarget) { exitFlg= true; break;} fn(index + 1, nextElements[i], content);} if (breakFlg) break;} var el= next(el);}}; var rootContent= createItem(&quot;ROOT&quot;, &quot;&quot;, 0); var elements= rootElement.getElementsByTagName(toc_options.target[0]); for (var i= 0; i &lt; elements.length; i++) { fn(0, elements[i], rootContent, &quot;&quot;);} return rootContent;} function createElement(rootContent) { var wrap= document.createElement(&quot;div&quot;); wrap.classList.add(&quot;b-toc-container&quot;); wrap.style.marginTop= toc_options.marginTop; wrap.style.marginBottom= toc_options.marginTop; if (toc_options.width== &quot;100%&quot;) { wrap.style.display= &quot;block&quot;;} else { wrap.style.width= toc_options.width;} var p= document.createElement(&quot;p&quot;); var span1= document.createElement(&quot;span&quot;); var span2= document.createElement(&quot;span&quot;); var span3= document.createElement(&quot;span&quot;); span2.classList.add(&quot;b-toc-show-wrap&quot;); span3.classList.add(&quot;b-toc-show-wrap&quot;); var a= document.createElement(&quot;a&quot;); span1.innerText= &quot;目次&quot;; span2.innerText= &quot;[&quot;; span3.innerText= &quot;]&quot;; a.href= &quot;javascript:void(0);&quot;; p.appendChild(span1); p.appendChild(span2); p.appendChild(a); p.appendChild(span3); var toggleToc= function (state) { var s= typeof state=== &quot;boolean&quot; ? state : hasClass(wrap, &quot;hide&quot;); if (s) { a.innerText= &quot;非表示&quot;; wrap.classList.remove(&quot;hide&quot;);} else { a.innerText= &quot;表示&quot;; wrap.classList.add(&quot;hide&quot;);}}; a.addEventListener(&apos;click&apos;, toggleToc); toggleToc(toc_options.showToc); var ul= document.createElement(&quot;ul&quot;); ul.classList.add(&quot;toc-root-list&quot;); rootContent.children.forEach(function (content, index) { createContentItemElement(ul, content, (index + 1) + &quot;&quot;);}); wrap.appendChild(p); wrap.appendChild(ul); return wrap;} function createContentItemElement(ul, content, no) { var li= document.createElement(&quot;li&quot;); li.classList.add(&quot;toc-list-item&quot;); var a= document.createElement(&quot;a&quot;); li.style.paddingLeft= toc_options.indent; ul.style.paddingLeft= 0; a.href= &quot;#&quot; + content.id; smoothScroll(a); if (toc_options.autoNumber) { var spanNm= document.createElement(&quot;span&quot;); spanNm.classList.add(&quot;toc-number&quot;); spanNm.innerText= no + &quot;.&quot;;} var spanText= document.createElement(&quot;span&quot;); spanText.classList.add(&quot;toc-text&quot;); spanText.innerText= content.text; if (toc_options.autoNumber) a.appendChild(spanNm); a.appendChild(spanText); li.appendChild(a); ul.appendChild(li); if (content.children.length &gt; 0) { var childUl= document.createElement(&quot;ul&quot;); childUl.classList.add(&quot;toc-sub-list&quot;); li.appendChild(childUl); content.children.forEach(function (childContent, index) { createContentItemElement(childUl, childContent, no + &quot;.&quot; + (index + 1));});}} function smoothScroll(a) { a.addEventListener(&apos;click&apos;, (e)=&gt; { e.preventDefault(); let href= a.getAttribute(&apos;href&apos;); let targetElement= document.getElementById(href.replace(&apos;#&apos;, &apos;&apos;)); const rect= targetElement.getBoundingClientRect().top; const offset= window.pageYOffset; const target= rect + offset - 0; window.scrollTo({ top: target, behavior: &apos;smooth&apos;, });});} function appendElement(element) { var el= null; var rootElement= document.querySelector(toc_options.postBodySelector); if (toc_options.insertPosition== &quot;firstHeadBefore&quot; || toc_options.insertPosition== &quot;firstHeadAfter&quot;) { el= rootElement.querySelector(toc_options.target[0]);} else if (toc_options.insertPosition== &quot;top&quot;) { el= rootElement;} if (el== null) return; if (toc_options.insertPosition== &quot;firstHeadBefore&quot;) { before(el, element);} else if (toc_options.insertPosition== &quot;firstHeadAfter&quot;) { after(el, element);} else if (toc_options.insertPosition== &quot;top&quot;) { before(el, element);}} function createItem(tagName, text, nestLevel, id) { return { tagName: tagName, text: text, children: [], nestLevel: nestLevel, id: id
};} function text(element) { return element.innerText;} function next(element) { return element.nextElementSibling;} function prev(element) { return element.previousElementSibling;} function tagName(element) { return element.tagName.toLowerCase();} function hasClass(element, className) { return element.classList.contains(className);} function parentElement(element) { return element.parentNode;} function after(element, insertElement) { var parent= parentElement(element); var nextEl= next(element); if (parent != null &amp;&amp; nextEl != null) { parent.insertBefore(insertElement, nextEl);}} function before(element, insertElement) { var parent= parentElement(element); if (parent != null) { parent.insertBefore(insertElement, element);}} })(window); 
  </script>
  <style type="text/css">
     .b-toc-container{background:#f9f9f9;border:1px solid #aaa;padding:10px;margin-bottom:1em;width:auto;display:table;font-size:95%}.b-toc-container p{text-align:center;margin:0;padding:0}.b-toc-container ul{list-style-type:none;list-style:none;margin:0;padding:0}.b-toc-container>ul{margin:15px 0 0}.b-toc-container.hide>ul{display:none}.b-toc-container ul li{margin:0;padding:0 0 0 20px;list-style:none}.b-toc-container ul li:after,.b-toc-container ul li:before{background:0;border-radius:0;content:""}.b-toc-container ul li a{text-decoration:none;color:#008db7!important;font-weight:400;display:flex;align-items:flex-start;flex-wrap:nowrap}.b-toc-container ul li .toc-number{margin:0 .5em 0 0;white-space:nowrap}.b-toc-container ul li .toc-text:hover{text-decoration:underline}
  </style>
</b:if>
<!-- [END] 目次作成プラグイン-->
プレビューで確認するとちゃんとできてました!!
(作成ビューには表示されないのでご注意)


カスタマイズ

もくじの見た目もソースを直接更新する、CSSを使うことでカスタマイズできます
特にCSSについては、こちらの[Blogger] 目次を簡単に自動生成(忙しい人向けのコピペ素材)の元記事に詳しい説明やカスタマイズのコードがありますのでぜひ!

個人的にはデフォルトのままで問題ないのでカスタマイズするつもりはなかったんですが、初期設定の確認をしていて一つだけこれはやったほうがいい! という設定がありました

condTargetCount もくじを作成する見出しの数の設定はマストで変える!



HTMLを直接編集します
初期設定は2になっています

見出しの数が2つ以上あったらもくじを作成する、ということは2つないともくじは作られないんです!(当たり前なことを言いましたw)

例えば、

見出し

小見出し

小見出し

という構成の記事だともくじは作られないんですね。

私は全然見出しが1つもありえる気がするので、まずはここを1に変えました。
すると参考の画像の状態のもくじも作成可能になりました!

その他、初期設定の内容の確認まとめ

初期状態で問題なく動作できている場合は気にしなくてもOKだと思いますが、
念のため初期設定で何ができるのか一つ一つ確認しました。
ここにないものはCSSを利用しないとアレンジできないということになります。

target: ["h2", "h3", "h4"],

もくじに使う見出しの設定
使えるのはh1~h6とのことなので必要に応じて追加できる

autoNumber: true,

もくじについているナンバリングのONOFF falseで消す

condTargetCount: 2,

もくじを作る見出しの最低数なので私は1にしました!

insertPosition: "firstHeadBefore",

もくじを表示する位置の指定/初期設定は最初の見出しの前
これで問題ないと思いますが、他は以下の2種類

記事の最上部 top
最初の見出しの後 firstHeadAfter

showToc: true,

もくじを最初から表示するかしないか falseで閉じられた状態になる

width: "auto",

もくじの横幅の設定
初期は自動調整になっていますので問題ないかと!

パーセンテージ指定はそのまま 数値%(100%最大)
固定にしたい場合は 数値pxでお好きな数値を

marginTop: "20px",

marginBottom: "20px",

もくじ上部と下部の余白の設定 こちらも20pxを好きな数値にして調整可能

indent:  "20px",

もくじのインデント幅
平たく言うと、見出しと小見出し等の段落の幅指定
見出し
    小見出しの文字下がりの幅

postBodySelector: ".widget.Blog"

こちらはもくじを作成してみて問題があった場合に変更してみると解決するかも、な設定です。
環境によっては記事本文以外にも見出しのタグを使っていて、それが目次に含まれてしまうケースがあるようです

その場合は".post-body"(記事本文)に設定
だいたいのケースが記事本文内のもくじ作成なのでもしかして基本的にこちらでいいのかな?という気がしますが、初期設定で問題ないのであれば触らないのが作者さんから推奨されていました!


これらを一つ一つ確認しても、もくじ作成条件以外は初期設定で問題ないと思いますので、あっという間に自動でもくじができて大助かりですね!
ありがとうございました!!


(QooQで確認しました)
Next Post Previous Post
No Comment
Add Comment
comment url