如何使用Markdown生成目录索引

叁歲伎倆 2024-05-07 22:23 171阅读 0赞

一、Markdown生成目录索引怎么折叠

在Markdown中,可以使用[TOC]语法生成目录索引。

如果想要折叠目录,则需要使用一些插件,如Tocbot、jquery-tocify等。

例如,在使用Tocbot时,可以在Markdown文档中加入以下代码:

  1. <!--请加入以下代码-->
  2. <script>
  3. tocbot.init({
  4. // 折叠css样式
  5. collapseClass: 'tocbot-is-collapsed',
  6. // 列表css样式
  7. listClass: 'tocbot-list',
  8. // 链接css样式
  9. linkClass: 'tocbot-link',
  10. // 层级深度
  11. depth: 6,
  12. // 显示子目录数
  13. showAndHideOnMobile: true,
  14. });
  15. </script>

这样就可以在HTML中自动生成一个可折叠的目录了。

二、Markdown目录索引生成

Markdown可以在文末自动生成目录索引,让读者更直观地查看文章结构。

只需要在Markdown的文档中插入[TOC]语法,就可以自动生成目录索引了。

例如:

  1. # 这是一级标题
  2. ## 这是二级标题
  3. ### 这是三级标题
  4. [TOC]
  5. # 这是一级标题
  6. 正文内容

这样就可以在最上方自动生成目录索引了。

三、Markdown生成网页

Markdown可以方便地将文本转化为HTML页面展示。

只需在Markdown文件中加入以下代码:

  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Markdown to HTML</title>
  6. <link rel="stylesheet" href="style.css">
  7. </head>
  8. <body>
  9. ## 写入Markdown代码
  10. <div class="markdown">
  11. <!--在这里插入Markdown代码-->
  12. </div>
  13. ## 写入Mathjax
  14. <script type="text/x-mathjax-config">
  15. MathJax.Hub.Config({
  16. tex2jax: {
  17. inlineMath: [['$', '$']],
  18. displayMath: [['$$', '$$']],
  19. processEscapes: true,
  20. skipTags: ['script', 'noscript', 'style', 'textarea', 'pre', 'code'],
  21. ignoreClass: 'comment-content',
  22. processClass: 'math-content'
  23. },
  24. jax: ['input/TeX', 'output/HTML-CSS'],
  25. displayAlign: 'left',
  26. 'HTML-CSS': {
  27. linebreaks: {
  28. automatic: true
  29. }
  30. }
  31. });
  32. </script>
  33. <script type="text/javascript" async
  34. src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
  35. </script>
  36. ## 添加目录
  37. <div class="toc">
  38. [TOC]
  39. </div>
  40. ## 加载目录插件
  41. <script src="toc.min.js"></script>
  42. </body>
  43. </html>

这样就可以生成一个包含目录索引的HTML页面了。

发表评论

表情:
评论列表 (有 0 条评论,171人围观)

还没有评论,来说两句吧...

相关阅读