自动说明文件(README.md)
当您的目录下存在README.md
这个文件时,Zdir会自动渲染此文件并输出。注意文件名称区分大小写,必须为README.md
,您可以在子目录下单独存放README.md
文件,这样进入不同的目录都会有不同的说明。
自动说明文件
比如我在公共目录(默认为Zdir安装目录的data/public
)下存放了一个README.md
文件,在面包屑导航的下方会出现一个“使用说明(README.MD)”的折叠面板,点击这个面板可以展开查看详细的说明文件。
子目录自动说明
如果您在子目录存放了README.md
文件,进入子目录时也会进行渲染该文件,从而实现不同的目录、不同的说明。比如我在data/public/zdir/3.0.0
目录下存放了一个README.md
文件,效果如下。