pardall_markdown

除了主要所需:static_assets_path之外，如果要使用静态文件，请在Phoenix.Endpoint配置中添加Plug.Static 。

 plug Plug.Static ,
    at: "/static/" , # if the static assets path ends at "/static", i.e. /path/to/content/static
    from: Content.Utils . static_assets_path ( ) ,
    gzip: true

检查演示申请中是否有完整的Phoenix应用程序样本，包括样本内容。或观看PardallmarkDown Phoenix Liveview教程视频。

使用PardallMarkdown.Repository检索内容。检查文档中的详细信息和说明。

 def get_all_posts ( type \ :all )
def get_all_links ( type \ :all )
def get_taxonomy_tree ( )
def get_content_tree ( slug \ "/" )
def get_all_published ( )
def get_by_slug ( slug )
def get_by_slug! ( slug )

API返回的内容是类型：

• PardallMarkdown.Content.Post （文档）
• PardallMarkdown.Content.Link （文档）
• PardallMarkdown.Content.AnchorLink （文档）

每个内容都有一个唯一的标识符，这仅仅是内容URL slug，例如： "/blog" ， "/docs/getting-started/how-to-install始终具有预先固定的斜线，但从来都不是trail slash。

SLUG用于使用PardallMarkdown.Repository重新函数：各个内容，树木和档案。 SLUG也是如何在缓存中识别内容的方式。

SLUG是从文件路径自动生成的。例如，一个名为： "/blog/news/Top news of_today.md"的降价文件将具有slug： "/blog/news/top-news-of-today" 。

Markdown文件可能包括顶部的元数据 /属性 /配置，其目的与前提相同。

元数据必须遵循所选PardallMarkdown.MetadataParser的模式和规格。解析器用配置密钥定义:metadata_parser 。

默认情况下，需要元数据，但是可以通过配置使其可选:is_markdown_metadata_required 。

可用以下配置属性（所有可选）：

• title ：帖子标题。如果未提供，将从邮政slug生成标题。
• date ：帖子，字符串，ISO格式的日期或日期时间。如果未提供，则文件修改日期将被视为发布日期。
• published ：没有published: true集将被视为草稿。当配置:is_content_draft_by_default设置为false时，默认值可以倒置，这样，帖子将始终视为发布，除非它们包含： published: false 。
• summary ：帖子说明或简短内容。如果未提供summary ，将从帖子的内容/正文中产生摘要。
• position ：如果帖子最高分类法具有:sort_by规则设置为:position ，则这是用于对帖子进行排序的值（请参见下文）。
• slug ：覆盖邮局。如上所述，默认情况下，slug是从文件名生成的，是帖子的主要唯一标识符。
  • 如果您用此属性覆盖sl，请确保将完整的路径放在斜线上，例如： slug: "/my/custom/slug" 。
  • 当与此属性覆盖Slug时，您有责任放置不冲突的sl。
• 任何其他额外的属性将保存到邮政的PardallMarkdown.Content.Post.metadata字段中。

元数据是用长生不老药图定义的，由---隔开。属性是MAP键作为原子。

例子：

 % {
    title: "PardallMarkdown public release" ,
    date: "2021-09-11" , # or "2021-09-11T14:40:00Z"
    published: true ,
    summary: "This post announces the launch of the project" ,
    position: 0 ,
    my_custom_data: :used_by_my_custom_application
}
---
Content goes here

如果要使用自动值，则映射可以为空（或者可以在is_markdown_metadata_required: false ）：

 % {
}
---
Content goes here 

从Joplin注释导出的Markdown帖子始终包含顶部的帖子标题，由空白行隔开，示例：

 Post title

... content goes here

Parser PardallMarkdown.MetadataParser.JoplinNote可以使用Joplin Notes。请注意，即使在乔普林（Joplin）内部，您也可以将元数据添加到Joplin注释中。元数据格式必须在选定的解析器中，然后您只需在joplin本身的注释顶部添加它，例如：

注意标题：“帖子标题”

 %{
  position: 0
}
---
Content goes here.

乔普林将其导出为：

 Post title

%{
  position: 0
}
---
Content goes here.

您可以将任何元数据解析器用于Joplin Notes（默认情况下，使用PardallMarkdown.MetadataParser.ElixirMap的Elixir Maps）使用配置：

 config : pardall_markdown , PardallMarkdown.MetadataParser.JoplinNote,
  metadata_parser_after_title: PardallMarkdown.MetadataParser.ElixirMap

要实现解析器，请检查行为PardallMarkdown.MetadataParser和现有包含的解析器（in /lib/ pardall_markdown /metadata_parser/ ）。

在最高分类法内，可以创建一个可以包含分类法配置的_index.md （通过元数据映射）以及分类学存档页面的可选PardallMarkdown.Content.Post内容，该文件的内容可保存到PardallMarkdown.Content.Link.index_post中。

_index数据映射可能包含：

• :title ：覆盖分类学标题/名称。
• :sort_by ：儿童发布分类规则（对于本分类法内的所有级别中的所有帖子）。接受的值:title | :date | :position 。
• :sort_order ：接受的值:desc | :asc 。
• 任何其他额外的属性将保存到分类法的PardallMarkdown.Content.Link.index_post.metadata字段中。

请注意， _index文件不能通过slug调用，即"/taxonomy/-index" ，而必须获得分类法，并通过PardallMarkdown.Content.Link.index_post访问文件并发布数据。

每个标记文件都是帖子（一块内容），但是pardallmarkDown考虑了根文件夹中的文件"/"为“页面”，并在任何层次结构级别，“ post”中任何文件夹中的文件。页面与根部层次结构并排添加到内容树。

从结构上讲，它们是相同的，唯一的区别是它们的属性设置为PardallMarkdown.Content.Post.type: :post | :page 。

示例：

• 页面：可以参考固定数据的单个唯一帖子，例如联系人或有关页面（ /contact， /over等）。
• 帖子：其他所有内容，包括博客文章，文档页面，Wiki页面等等，等等，这些内容至少在一个级别的分类学内部，例如： "/docs/introduction"或"/wiki/languages/english/verbs/to-eat" 。

类别，分类法和网站部分均指相同的内容：包含帖子的文件夹的层次结构，这些文件夹中包含在其中，这又定义了帖子集或帖子组。

• 分类/类别/部分/组名称来自文件夹名称，每个单词都大写。
• 层次结构由嵌套文件夹定义。
• 顶级分类法是第一级文件夹，例如： "/blog" ，因此"/blog/news/art"将"/blog"作为其最高分类法/父母。
• 帖子单独保存（用PardallMarkdown.Repository.get_by_slug("/a/post/slug") ）及其分类法和分类法的层次结构。分类档案库（分类法的所有职位）及其层次结构包含在PardallMarkdown.Content.Link.children中，当时分类学通过：
  • PardallMarkdown.Repository.get_by_slug("/taxonomy/inner-taxonomy")
  • PardallMarkdown.Repository.get_content_tree("/taxonomy/inner-taxonomy")
  • PardallMarkdown.Repository.get_content_tree("/") - root，其中包含所有分类法，其帖子和层次结构。
• 当通过PardallMarkdown.Repository.get_by_slug("/taxonomy/inner-taxonomy")检索Slug的分类学时，分类学:children包含其所有最内部分类法的所有职位:children 。
  • 例如，帖子：“/blog/news/news/city/foo”出现在:children ： "/blog" ， "/blog/news"和"/blog/news/city"中。
• 另一方面，用PardallMarkdown.Repository.get_content_tree/1检索的内容树中的分类学仅包含其直接子女帖子。
  • 例如，帖子：“/blog/news/news/city/foo”仅在其定义分类法的:children中出现： "/blog/news/city" 。

考虑示例内容目录结构：

 content/
|   about.md
|   contact.md
└───blog/
|   |   _index.md
|   |   post1.md
|   |   post2.md
|   └───art/
|   |   └───traditional/
|   |       └───oil-paintings/
|   |           └───impressionism/
|   |               └───claude-monet/
|   |               └───pierre-auguste-renoir/
|   └───news/
|       |   .. posts..
|       └───city/
|       |   |   ..posts..
|       └───worldwide/
|           |   ..posts..
└───docs/
|   |   _index.md
|   |   getting-started.md
|   └───setup/
| ...more and more...

另外，请考虑docs/_index.md定义A： docs文件夹的:title ，该文件将覆盖默认命名约定。

将创建以下类别：

 ["Blog"]
["Blog"]["Art]
["Blog"]["Art]["Traditional"]
["Blog"]["Art]["Traditional"]["Oil Paintings"]
["Blog"]["Art]["Traditional"]["Oil Paintings"]["Impressionism"]
["Blog"]["Art]["Traditional"]["Oil Paintings"]["Impressionism"]["Claude Monet"]
["Blog"]["Art]["Traditional"]["Oil Paintings"]["Impressionism"]["Pierre Auguste Renoir"]
["Blog"]["News"]
["Blog"]["News"]["City]
["Blog"]["News"]["Worldwide]
["Documentation"]
["Documentation"]["Setup]

每次重新编译内容时，都会生成三种树木。

这些树可用于导航内容，可以将其打印为链接列表等。检查演示项目，以获取如何使用树和HTML帮助者从树中生成链接的多个示例。

树木是：

一棵拥有所有分类法的树，用标题排序，并相应地嵌套。

分类树可以通过PardallMarkdown.Repository.get_taxonomy_tree/0检索。

一棵包含所有分类法的树，但他们的孩子帖子嵌套了：

• 帖子位于其最内部的分类法下方。
• 帖子以其最高的分类分类规则进行排序。

创建了多个内容树。一个单一的“主”内容树，可通过root slug "/"获得每个分类学级别的内容树。例如，文档层次结构的内容树，其中包含指向所有子层次结构和帖子的链接。

内容树可以通过PardallMarkdown.Repository.get_content_tree/1检索。

在当前帖子之后，将所有帖子内部的链接插入了上一个和下一个帖子。这些链接在PardallMarkdown.Content.Post.link.previous和PardallMarkdown.Content.Post.link.next中。

每个帖子都包含自己的自动生成的目录树，可在邮政的PardallMarkdown.Content.Post.toc字段内使用。

TODO：描述FileWatcher背压机制。

单独的存储库中有一个演示项目：PardallmarkDown Phoenix Demo。