ooblatron / bootdown
使用Markdown文件快速创建Bootstrap样式的简单网站
1.1.3
2022-12-09 14:52 UTC
Requires
- php: >=7.1
- erusev/parsedown: ^1.7
- ooblatron/slipstream: ^1.0
- ooblatron/tsuka: ^1.1
- vlucas/phpdotenv: ^5.5
README
Bootdown 允许您使用Markdown文件仅通过Bootstrap样式快速创建简单网站
安装
使用以下命令安装最新版本
composer create-project ooblatron/bootdown-site .
将您的网站根目录指向 html
。
基本用法
通过将Markdown文档上传到docs目录并将它们映射到URL来添加新页面,方法是在config/Map.php
文件中进行更改。
例如
- 将名为
world.md
的Markdown文档上传到docs目录 - 将以下行添加到
config/Maps.php
'hello' => 'world.md'
访问 https://yourdomain.com/hello
将显示 world.md
的内容,并带有 Bootstrap 样式。
您可能希望Markdown文件名与URL路径匹配,但如示例所示,不必如此。
您还可以将子目录中的Markdown文件映射,例如
'hello' => 'greetings/world.md'
当访问 https://yourdomain.com/hello
时,这将显示Markdown文件 docs/greetings/world.md
。
如何使用Markdown
如果您需要帮助格式化文档,请参阅Markdown指南。
更多信息
文档
关于
要求
- PHP 7.1或更高版本
- 依赖注入的Composer包 ooblatron/slipstream
- 将Markdown转换为HTML的Composer包 erusev/parsedown
- 用于添加Bootstrap样式的Composer包 ooblatron/tsuka
Bootstrap版本
Bootdown的第1版支持Bootstrap 4。
作者
Tim Rogers - tim@ooblatron.org - https://twitter.com/timdrogers
许可证
Bootdown采用MIT许可证 - 有关详细信息,请参阅LICENSE文件。
致谢
此包使用出色的Bootstrap框架,允许后端开发人员创建干净、专业的网页,而无需深入了解图形设计或CSS。
用于显示HTTP错误代码的图形来自Laravel版本5.7。
`.htaccess`语法来自用户jacoz提供的Stackoverflow答案。