README

Carta提供了一种简单的方法将不同的标记语言转换为HTML（具有讽刺意味）。目前它支持Markdown和reStructuredText。

示例

$carta = new \Gentle\Carta\Carta(
    '/path/to/markdown/files',
    new \Gentle\Carta\Parser\MarkdownParser()
);

# parse a single page and get content
$carta->page('subdir/file.md')->getContent();

# load all files from directory and get each page title
foreach ($carta->chapter('subdir/')->getPages() as $page) {
    echo $page->getMetaTag('title');
}

页面元数据

您可以在每个源文件内部指定自定义元数据，通过在文件开头使用格式key: value实现，前后用三个或更多短横线包围。

示例

---
title: "The page title"
description: "Page description"
tags: ["tag1", "tag2"]
---

这将导致以下使用方式

// [...]
$page->getMetaTag('title');        // will return: The page title
$page->getMetaTag('description');  // will return: Page description
$page->getMetaTag('tags');         // will return: array('tag1', 'tag2')

对于可以使用的元数据键没有限制，因此您可以定义任何键。

术语表

以下术语在Carta库中使用

页面：指单个源文件（例如.md, .rst等）。
章节：指包含多个“页面”的目录。

许可证

Carta采用MIT许可证 - 请参阅LICENSE文件以获取详细信息。

gentle / carta

维护者

详细信息

README

示例

页面元数据

术语表

许可证