【免费下载链接】pelicanStatic site generator that supports Markdown and reST syntax. Powered by Python.项目地址https://gitcode.com/gh_mirrors/pe/pelican点击查看免费下载本篇技术指南以 Pelican 测试套件中的 draft_page_markdown.md 为切入点讲解如何用 Markdown 为 Pelican 静态站点生成草稿draft状态的页面。你将掌握status元数据的取值语义、草稿页面的生成与输出原理、DRAFT_*系列 URL 配置以及如何借助DEFAULT_METADATA自动防止文章被意外发布从而搭建一套先草稿后发布的内容管理流程。从一个 12 行的测试文件说起在 Pelican 仓库的测试目录pelican/tests/TestPages/下存放着一组用于验证PagesGenerator行为的页面样本其中 draft_page_markdown.md 完整内容如下title: This is a markdown test draft page status: draft Test Markdown File Header Used for pelican test --------------------- The quick brown fox . This page is a draft这个文件麻雀虽小五脏俱全恰好演示了 Pelican 草稿页面的全部关键要素Markdown 前置元数据front matter文件开头用key: value形式声明元数据title指定页面标题status: draft声明该页面处于草稿状态正文使用标准 Markdown 语法下划线构成一级标题Setext 风格-----构成二级标题正文为普通段落文本测试样本定位它是与 draft_page.rstreST 版本并列的 Markdown 版本用于证明无论内容格式是 Markdown 还是 reSTstatus: draft都能被一致地识别与处理。仓库中还提供了这一机制的 reST 对照样本 draft_page.rst其写法是在文档末尾附加:status: draft字段正文结构完全一致。两份样本共同构成了同一声明、双格式验证的测试设计。status 元数据页面与文章的四种状态status不是自由文本它在源码层面对取值做了严格约束。在 pelican/contents.py 中Page类页面与Article类文章均定义了相同的状态白名单class Page(Content): mandatory_properties (title,) allowed_statuses (published, hidden, draft, skip) default_status published default_template page状态值行为语义典型用途published默认状态正常参与首页、分类、标签等索引与聚合正式对外发布的内容draft输出到独立的 drafts 目录不进入任何索引页与订阅源待审核、待完善的内容hidden按*_SAVE_AS正常输出但默认不进入标签、分类、作者索引与主订阅源创建未列出的私密页skip完全忽略不处理也不输出临时禁用某篇内容从源码结构可以推断状态判定发生在生成阶段而非解析阶段Page/Article解析后由生成器读取page.status属性完成分发详见下一节因此只需修改元数据中的status值即可在不改动正文的前提下切换页面的发布状态。草稿页面的模板与类名细节Page._expand_settings()中存在一个容易被忽略的细节pelican/contents.pydef _expand_settings(self, key: str) - str: klass draft_page if self.status draft else None return super()._expand_settings(key, klass)即草稿页面在展开输出路径时使用draft_page这一类别标识而草稿文章在 Article._expand_settings 中对应使用draft类别。这意味着在配置PAGE_SAVE_AS等模板字符串时可以像下面这样为草稿页面单独定制输出路径PAGE_SAVE_AS pages/{slug}.html # 草稿页面可被路由到独立目录例如 DRAFT_PAGE_SAVE_AS drafts/{slug}.html生成器如何分流草稿页面页面状态的分类逻辑位于PagesGenerator.generate_context()pelican/generators.py。生成器遍历PAGE_PATHS下的每一个文件读取为Page对象后按状态分发if page.status published: all_pages.append(page) elif page.status hidden: hidden_pages.append(page) elif page.status draft: draft_pages.append(page) elif page.status skip: raise AssertionError(Documents with skip status should be skipped)随后三个列表各自经过翻译处理process_translations与排序order_content后分别挂载为generator.pages、generator.hidden_pages、generator.draft_pages并统一写入模板上下文generator.context。文章侧的分流逻辑完全对称见 pelican/generators.pypublished进all_articles、draft进all_drafts、hidden进hidden_articles。值得注意的是generate_output()pelican/generators.py会对草稿页面执行完整的写文件流程调用writer.write_file并传入draft.save_as也就是说草稿页面虽然不进索引但依然会被渲染成静态 HTML 文件——这正是给朋友预览场景的实现基础草稿有独立 URL只是不对外暴露入口。文章侧的特殊规则未来日期自动转草稿对于文章Article草稿状态还有一个自动触发途径pelican/contents.py当设置WITH_FUTURE_DATES False默认值时若文章date晚于当前时间其status会被自动改写为draft实现定时发布效果反过来若一篇草稿文章没有声明datePelican 会将其日期补为datetime.datetime.max确保它在按时间排序时被排到最后。页面对此不做处理因为页面不强制要求日期字段Page.mandatory_properties (title,)。草稿的 URL 与输出位置草稿的输出路径由 pelican/settings.py 中的默认设置决定设置项默认值说明DRAFT_URLdrafts/{slug}.html草稿文章的 URLDRAFT_SAVE_ASdrafts/{slug}.html草稿文章的输出路径DRAFT_LANG_URLdrafts/{slug}-{lang}.html多语言草稿文章的 URLDRAFT_LANG_SAVE_ASdrafts/{slug}-{lang}.html多语言草稿文章的输出路径可以看到草稿文章默认统一落入站点根目录的drafts/文件夹例如drafts/my-post.html与正式内容的ARTICLE_URL/ARTICLE_SAVE_AS路径天然隔离。这一设计同样适用于草稿页面draft_page_markdown.md在测试中被渲染为草稿页面后其输出目录与正式页面如pages/下互不干扰。你可以覆盖上述四个设置将草稿集中放置到任意自定义目录。另外草稿内容不会被加入任何索引页或订阅源。ArticlesGenerator在构建标签、分类、作者页及 feed 时只遍历正式文章列表草稿列表被排除在外参见 pelican/generators.py 附近对drafts上下文的写入位置。从 changelog 看草稿功能经历了支持草稿文章 → 页面支持 draft 状态 → 支持语言翻译草稿的演进docs/changelog.rst这也解释了DRAFT_LANG_*的存在。把所有内容默认草稿写进配置官方文档 Publishing drafts 提供了一个非常实用的模式如果担心文章还没写完就被意外发布可以在pelicanconf.py中通过DEFAULT_METADATA把默认状态设为草稿DEFAULT_METADATA { status: draft, }这样所有未显式声明status的文章/页面都会自动成为草稿当内容真正完成时只需在文件元数据中显式覆盖title: 我的新文章 status: published同理若要手动把某篇内容转为草稿将其元数据改为status: draft即可。这一机制与 draft_page_markdown.md 的做法完全一致——草稿状态就是元数据里的一个字段Pelican 据此决定内容的去处。测试如何验证草稿页面行为草稿页面的行为在测试套件中有多处验证可作为理解机制的参照pelican/tests/test_generators.py 的TestPageGenerator.test_generate_context()将PAGE_PATHS指向TestPages目录后断言generator.draft_pages恰好包含三条记录其中就包括[This is a markdown test draft page, draft, page]——元组依次为标题、状态、模板可见草稿页面的template仍为默认的page同一测试还同时断言generator.pages、generator.hidden_pages与generator.context[draft_pages]证明草稿页面与正式、隐藏页面在上下文与生成器属性两个层面都被正确分流pelican/tests/test_cache.py 验证缓存机制下generator.draft_pages在两次读取首次构建与缓存命中间保持一致说明草稿列表同样参与缓存化处理pelican/tests/test_contents.py 则从Content对象层面验证status: draft元数据能被正确解析并写入static.status。此外命令行在每次构建结束后会输出处理统计其中会区分N articles、M drafts、K draft pages等见 pelican/init.py方便你直观确认草稿数量是否符合预期。与 hidden、skip 的边界理解草稿的最佳方式之一是把它和另外两个非发布状态放在一起对比draft渲染为独立 HTMLdrafts/目录不进任何索引与 feed适合发布前预览hidden按正式路径输出ARTICLE_SAVE_AS但默认不进标签/分类/作者索引和主 feed效果是有 URL 但不出现在列表里适合不公开的私密内容skip完全跳过解析与输出既不生成文件也不进索引docs/content.rst。三者的共同点是都不会出现在首页、分类页、标签页等公开聚合位置区别在于草稿有独立输出目录、隐藏内容按正式路径输出、跳过内容不输出。小结一套可落地的草稿工作流结合官方文档、测试样本与源码实现在 Pelican 中管理草稿页面的完整工作流如下在pelicanconf.py中设置DEFAULT_METADATA {status: draft}从源头避免误发布编写内容时使用 Markdown或 reST前置元数据如 draft_page_markdown.md 所示声明title与status运行pelican content构建站点草稿自动渲染到drafts/{slug}.html可通过该 URL 分享给协作者预览内容定稿后将元数据改为status: published重新构建文章/页面即进入正式索引与订阅源若某篇内容希望有链接但不公开改用status: hidden若想彻底停用某篇内容使用status: skip。这套机制全部由status一个字段驱动配合生成器分流pelican/generators.py与DRAFT_*URL 配置pelican/settings.py即可在纯静态站点上实现草稿 → 预览 → 发布的轻量级内容治理。赞分享【免费下载链接】pelicanStatic site generator that supports Markdown and reST syntax. Powered by Python.项目地址https://gitcode.com/gh_mirrors/pe/pelican点击查看免费下载相关推荐Pelican 页面草稿与自定义模板基于 reST 元数据的 status / template 机制实战Pelican 页面草稿与自定义模板基于 reST 元数据的 status / template 机制实战 本文以 Pelican 官方测试用例 draft_Pelican 草稿Draft机制全解析从 draft_page.rst 看 status 元数据与草稿生成管线Pelican 草稿Draft机制全解析从 draft_page.rst 看 status 元数据与草稿生成管线 本指南以 Pelican 测试套件中的从排序测试页看 Pelican 页面排序机制PAGE_ORDER_BY 配置与 reST 元数据实战从排序测试页看 Pelican 页面排序机制PAGE_ORDER_BY 配置与 reST 元数据实战 Pelican 是一个基于 Python 的静态站点生成创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考