通过 
搜索
搜索basteyy / static-markdown-pages
1.0.0
2021-12-15 15:20 UTC
Requires
- php: 8.1.*
- league/commonmark: 2.*
- symfony/yaml: v6.*
This package is auto-updated.
Last update: 2024-09-15 21:02:28 UTC
README
一个用于在项目中使用静态Markdown页面的工具。
设置
composer require basteyy/static-markdown-pages
用法
首先您需要拥有自己的Markdown页面。在以下示例中，我期望您在 /var/www/storage/my_pages/ 目录下存储了一些文件。
$ ls /var/www/storage/my_pages/ my_file_1.md my_file_2.md fancy-third-file.md
每个页面需要在文档开头包含一些元数据。
例如 fancy-third-file.md 的内容
$ cat /var/www/storage/my_pages/fancy-third-file.md
title: I'm the fancy third file! url: /fancy-third/ author: John Doe === # Example Markdown Page As you can see .. this is markdown
/** @var \basteyy\StaticMarkdownPage\Archive $staticPages */ $staticPages = new \basteyy\StaticMarkdownPage\Archive('/var/www/storage/my_pages/');
要获取fancy-third-file，您需要将url传递给getByUrl方法
/** @var \basteyy\StaticMarkdownPage\Archive $staticPages */ /** @var \basteyy\StaticMarkdownPage\Page $page */ $page = $staticPages->getByUrl('/fancy-third/');
现在您可以打印文件
/** @var \basteyy\StaticMarkdownPage\Archive $staticPages */ /** @var \basteyy\StaticMarkdownPage\Page $page */ echo $page->getHtml();
就这样。