[!Note]

https://www.latelee.org/my-study/gitbook-note.html

https://jiangminggithub.github.io/gitbook/1-install.html

安装

需要node 10.x,不然后面初始化会报错

  1. npm install -g gitbook-cli

初始化

  1. gitbook init

image-20210330143938499初始化过后会多2个文件,分别是

  1. README.md(书籍的介绍在这个文件里)
  2. SUMMARY.md(书籍的目录结构在这里配置)

写目录

可以参考最下面的一键生成

  1. * [CS](CS/CS.md)
  2. * [1.破解CS](CS/破解CS.md)
  3. * [2.Malleable C2 Profiles](CS/Malleable-C2-Profiles.md)
  4. * [3.启动](CS/启动.md)
  5. * [4.目录和菜单中文说明](CS/目录和菜单中文说明.md)
  6. * [5.Beacon](CS/Beacon.md)
  7. * [6.进阶:隐藏C2 - 通过特征](CS/进阶:隐藏C2 - 通过特征.md)
  8. * [7.进阶:隐藏C2 - 通过CDN](CS/进阶:隐藏C2 - 通过CDN.md)
  9. * 内网
  10. * [1.内网基础知识整理](内网/1.内网基础知识整理.md)
  11. * [2.Kerberos协议](内网/2.kerberos协议.md)
  12. * [3.委派](内网/3.委派.md)
  13. * [4.ACL](内网/4.ACL.md)
  14. * [5.域环境搭建](内网/5.域环境搭建.md)
  15. * [6.内网渗透流程](内网/6.内网渗透流程.md)
  16. * [7.网络环境的判断](内网/7.网络环境的判断.md)
  17. * [8.内网权限提升](内网/8.内网权限提升.md)
  18. * [9.信息收集](内网/9.信息收集.md)
  19. * [10.横向移动](内网/10.横向移动.md)
  20. * [11.工具小结](内网/11.工具小结.md)
  21. * [12.攻击手法](内网/12.攻击手法.md)

image-20210331010109185## 更新 写完目录后再次执行gitbook init
Gitbook会查找SUMMARY.md中描述的目录和文件,如果没有则会创建。上面的目录运行后是这样的 image-20210330145100857## 启动WEB

  1. gitbook serve

image-20210330145301325## 生成静态网站

  1. gitbook build --format website

安装插件

新建book.json输入以下内容

[!NOTE]

这些都是我自己使用的插件,算是做个备份汇总吧

  1. {
  2. "title" : "d4m1ts 知识库",
  3. "author" : "d4m1ts",
  4. "description" : "个人的部分知识技能,倾向于使用知识库的方式进行总结回顾自己",
  5. "theme-default": {
  6. "showLevel": true
  7. },
  8. "plugins": [
  9. "-lunr", "-search", "search-plus", "-highlight", "chapter-fold",
  10. "expandable-chapters","splitter", "page-treeview", "lightbox",
  11. "donate", "hide-element", "code", "tbfed-pagefooter",
  12. "pageview-count", "ancre-navigation", "anchor-navigation-ex", "insert-logo",
  13. "favicon","github","flexible-alerts","prism","copyright"
  14. ],
  15. "pluginsConfig": {
  16. "page-treeview": {
  17. "copyright": "Copyright © d4m1ts",
  18. "minHeaderCount": "2",
  19. "minHeaderDeep": "2"
  20. },
  21. "donate": {
  22. "wechat": "/README.assets/wx.jpeg",
  23. "alipay": "/README.assets/alipay.jpeg",
  24. "title": "",
  25. "button": "打赏☕️",
  26. "alipayText": "支付宝打赏",
  27. "wechatText": "微信打赏"
  28. },
  29. "hide-element": {
  30. "elements": [".gitbook-link", ".treeview__copyright", ".treeview__main-title"]
  31. },
  32. "tbfed-pagefooter": {
  33. "copyright":"Copyright &copy d4m1ts 2022",
  34. "modify_label": "该文章修订时间:",
  35. "modify_format": "YYYY-MM-DD HH:mm:ss"
  36. },
  37. "insert-logo": {
  38. "url": "/README.assets/logo.png",
  39. "style": "background: none; max-height: 40px; min-height: 40px"
  40. },
  41. "favicon": {
  42. "shortcut": "/README.assets/favicon.ico",
  43. "bookmark": "/README.assets/favicon.ico",
  44. "appleTouch": "/README.assets/favicon.ico",
  45. "appleTouchMore": {
  46. "120x120": "/README.assets/favicon.ico",
  47. "180x180": "/README.assets/favicon.ico"
  48. }
  49. },
  50. "github": {
  51. "url": "https://github.com/damit5"
  52. },
  53. "flexible-alerts": {
  54. "style": "callout",
  55. "comment": {
  56. "label": "Comment",
  57. "icon": "fa fa-comments",
  58. "className": "info"
  59. }
  60. },
  61. "prism": {
  62. "css": [
  63. "prismjs/themes/prism-tomorrow.css"
  64. ],
  65. "lang": {
  66. "flow": "typescript"
  67. },
  68. "ignore": [
  69. "mermaid",
  70. "eval-js",
  71. "ascii",
  72. "result",
  73. "manifest",
  74. "payload",
  75. "google",
  76. "tree",
  77. "java_out",
  78. "log4j2",
  79. "jsp",
  80. "class",
  81. "Exception",
  82. "stack"
  83. ]
  84. },
  85. "copyright": {
  86. "site": "https://blog.gm7.org/",
  87. "author": "d4m1ts",
  88. "website": "d4m1ts 知识库",
  89. "image": "",
  90. "copyProtect": true
  91. }
  92. }
  93. }

然后运行

  1. gitbook install

然后启动就可以了

  1. gitbook serve

https://www.jianshu.com/p/2160f1ba68a0

常用插件

  1. # 全面
  2. https://jiangminggithub.github.io/gitbook/6-third_plugins.html
  3. https://www.jianshu.com/p/427b8bb066e6
  4. https://segmentfault.com/a/1190000019806829
  5. http://jartto.wang/2020/02/02/about-gitbook/
  6. https://juejin.cn/post/6844903865146441741
  7. https://github.com/orgs/GitbookIO/repositories?type=all
  8. https://github.com/search?q=gitbook-plugin-&type=all

快速生成summary

https://blog.csdn.net/weixin_34383618/article/details/91629912

  1. npm install -g gitbook-summary
  2. book sm
  3. book sm -i node_modules,_book # 忽略 node_modules和_book目录

flexible-alerts 高级格式显示的提示块

用法:

  1. > [!type|style:xx|label:xx|icon:xx|className:xx|labelVisibility:xx|iconVisibility:xx]
  2. > 内容部分

字段介绍,如果不设置的表示选择默认,除了!type都不是必需的。

| 键 | 允许的值 | 说明 | | —- | —- | —- |

| !type | NOTETIPWARNINGDANGER | 警告级别设置 |

| style | 以下值之一: callout(默认), flat | 警告样式,见图19的左右不同 |

| label | 任何文字 | 警告块的标题位置,即Note这个字段位置(不支持中文) |

| icon | e.g. ‘fa fa-info-circle’ | 一个有效的Font Awesome图标,那块小符号 |

| className | CSS类的名称 | 指定css文件,用于指定外观 |

| labelVisibility | 以下值之一:visible(默认),hidden | 标签是否可见 |

| iconVisibility | 以下值之一:visible(默认),hidden | 图标是否可见 |

实例:

  1. 1. 这是简单的用法
  2. > [!NOTE]
  3. > 这是一个简单的Note类型的使用,所有的属性都是默认值。
  4. ---
  5. 2. 这是自定义属性的用法
  6. > [!NOTE|style:flat|lable:Mylable|iconVisibility:hidden]
  7. > "!type":`NOTE`"style":`flat`"lable":`自定义标签`、图标不可见

1、Note

[!NOTE]
这是一个简单的Note类型的使用,所有的属性都是默认值。

2、TIP

[!TIP]
TIPS

3、WARNING

[!WARNING]
WARNING|WARNING

4、DANGER

[!DANGER]
DANGER

5、自定义

[!COMMENT]
自定义的,在book.json中配置

6、正常

正常测试

7、高级使用

[!NOTE|style:flat|lable:Mylable]
“!type”:NOTE、”style”:flat、”lable”:自定义标签、图标可见

page-treeview 生成页内目录

生成后,会出现这一行,想要删除有2种方法:
image-20211228125624904

  1. 直接用hide-element来隐藏,治标不治本
  2. 直接修改插件源码node_modules/gitbook-plugin-page-treeview/lib/index.js,删除如下部分即可

image-20211228125825996

二次修改插件

有时候一些插件不太合心意,可以稍微修改修改

[!TIP|style:flat]

修改其他插件一样,找到路径就行了,node_modules/gitbook-plugin-xxx里面的index.js

主要参考上面的page-treeview修改
本网站主要修改了2个插件:

  1. page-treeview
  2. copyright:去除了最下面的版权信息,因为感觉不好看。。。

    其他

https://stackoverflow.com/questions/41498252/gitbook-template-render-error-unknown-block-tag-static

举一些可能抛出异常的例子,用代码块``正常格式和起来就行

  1. - `{{ }}`
  2. * `{{ }}`
  3. ```test
  4. {{ aaa }}

```