markdown 静态网页生成器

LsBook的Python项目详细描述


LsBook

无法忍受 gitbook 龟速的生成速度,决定自己写一个用于书写自己的书籍生成器。

一切参照 gitbook,只为加快网站的生成速度。

只支持 md 语法

项目示例:https://github.com/liushilive/github_software_testing_dictionary

部署

部署 python,安装 lsbook

pip install lsbook

使用

lsbook -b --log debug <book> <output>

编辑 book.json

{"author":"作者","title":"书籍标题","language":"zh-cn",//arbncacsdeelenesfafifrheitjakonlnoplptrorusvtrukuizh-cnzh-hanszh-tw"github_url":"主页地址"}

数学公式使用

支持 KaTeX 已支持的全部符号。

  • 内联数学公式:

    $$\int_{-\infty}^\infty g(x) dx$$
    
    $$\fcolorbox{red}{aqua}{A}$$
    
    $$\textcolor{#228B22}{F=ma}$$
    
  • 块级数学公式:

    $$
    \def\arraystretch{1.5}
    \begin{array}{c|c:c}
      a & b & c \\ \hline
      d & e & f \\
      \hdashline
      g & h & i
    \end{array}
    $$
    

流程图使用

  • 支持 mermaid 以支持的流程图。

    ```mermaid
    graph TD;
      A-->B;
      A-->C;
      B-->D;
      C-->D;
    ```
    

代码高亮支持

采用 prism 支持所有官方支持语言。

鼠标悬浮可见

用法:把要隐藏文本内容放在 {%s%}{%ends%} 之间。

{%s%}Hello World.{%ends%}

点击隐藏或显示片段

可以使用标签定义一个新的片段:(默认隐藏),不支持嵌套

<!--sec data-title="点我隐藏答案" data-show=true ces-->
B
<!--endsec--><!--sec data-title="点我看分析" data-id="section2" data-show=false ces-->
CPU
<!--endsec--><!--sec data-title="点我看分析" ces-->
C
<!--endsec-->

本标签包含以下参数:

  • title:标题
  • show:是否初始隐藏

导入外部代码文件

@import "你的代码文件" {语言}

@import "你的代码文件"

如果没有指明相关语言,将默认根据文件后缀推断语言。

如果文件为 markdown,将直接引入文件中内容。文件中图片会导入到当前项目中。

自定义 js

书籍目录下创建 book.js 文件保存自定义 js 内容。

内容将在页面加载后运行。

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
在嵌套的json字符串Java中附加双引号   java我应该首先将客户机的流读入字符串,然后解析HTTP,还是在从客户机的流中获取输入的同时解析HTTP?   java方法永远不会到达if语句,尽管它的条件得到了满足   java Spring Cloud Kinesis binder在启用kpl/kcl时创建SpringIntegrationMetadataStore和SpringIntegrationLockRegistry。有必要吗?   为什么打印空字符串时会弹出零?   java Swagger API规范自定义API响应属性usign@ApiPropertyModel   抽象类中受java保护的数据   java将参数作为参数从jsf页面传递给bean,并保存它   java在转换为字符串后丢失HTML转义   Java注释:使用注释更改数据   Java中XML XSD到AVRO avsc的映射   java将TreeView的子项、子项、子项着色   java如何在Springbeans中获取HttpServletRequest?   Java和MySQL如何在涉及外键时设计类