简介
npm包@jacksontian/writing是一个基于markdown的写作工具,可以快速生成博客,文章等内容。它提供了丰富的扩展语法,支持数学公式、流程图、时序图等,极大地提高了写作效率和可读性。
安装
--- ------- -- --------------------
使用
创建一个新文章
使用以下命令来创建一个新的markdown文章
------- ----- ------
扩展语法
数学公式
使用两个美元符号$$
包裹数学公式,如下
-- - - --- --
流程图
使用Mermaid语法绘制流程图,如下
----- --- ------ ------ ------ ------
时序图
使用Mermaid语法绘制时序图,如下
--------------- ----------- ----- ----------- --- ------------- -------------- ------- ------------- -------------- --------
图片
图片可以通过相对路径引用,如下
------------------------------
内容检查
提供--check
参数来检查文章中链接的图片是否存在
------- -------
主题
通过指定主题可以快速切换样式、配色等
------- ------- ------
支持多个主题,具体可在官方文档中查看。
示例
以下是一个使用@jacksontian/writing编写的markdown文章,使用了Mermaid语法绘制了流程图。
- ------------------------ -- -- ---------------------------------------- -- --- ---------- ----- -- ------ ------ ------ ------
数学公式
以下是一个简单的数学公式
$$ y = x^2 $$
-- --- -------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------ ---------- -----------------------------------------------------------------------------------------------------------------------------