ooblatron / bootdown-site
一个用于快速入门Bootdown的示例网站
Requires
- php: >=7.1
- ooblatron/bootdown: ^1.1
This package is auto-updated.
Last update: 2024-09-09 12:13:18 UTC
README
Bootdown 允许您仅使用 Markdown 文件创建具有 Bootstrap 样式的快速简单的网站
安装
使用以下命令安装最新版本
composer create-project ooblatron/bootdown-site .
将您的网站主机根目录指向 html
。
基本用法
通过上传 Markdown 文档到文档目录,并在 config/Map.php
文件中映射它们到 URL 来添加新页面。
例如
- 将名为
world.md
的 Markdown 文档上传到文档目录 - 在
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 用于依赖注入
- Composer 包 erusev/parsedown 用于将 Markdown 转换为 HTML
- Composer 包 ooblatron/tsuka 用于顶部和底部网页以及添加 Bootstrap 样式
Bootstrap 版本
Bootdown 1 版本支持 Bootstrap 4。
作者
Tim Rogers - tim@ooblatron.org - https://twitter.com/timdrogers
许可证
Bootdown 根据 MIT 许可证授权 - 有关详细信息,请参阅LICENSE 文件。
致谢
此包使用了出色的Bootstrap 框架,允许后端开发者创建干净、专业的网页,而无需深入了解图形设计或 CSS。
显示 HTTP 错误代码的图形来自Laravel 版本 5.7。
.htaccess 语法是从Stackoverflow 答案中获取的,该答案由用户jacoz 提供。