FAQtory

FAQtory是一个用于为您项目自动生成FAQ.md（常见问题）文档的工具。

此外，"建议"功能使用模糊匹配从FAQ中对GitHub问题提出建议。

入门指南

建议通过pipx安装Faqtory以避免任何依赖冲突

pipx install faqtory

在您希望存储FAQ文档的目录中运行以下命令。

faqtory init

这将创建以下文件和目录

• faq.yml 一个您可以编辑的配置文件。
• ./.faq/ 一个包含模板的目录。
• ./questions/ 一个包含问题文档的目录。

添加问题

要添加问题，在问题目录中（如果您使用默认设置则为./questions/）创建一个扩展名为.question.md的文件。

问题文档是带有前端的Markdown。以下是一个示例

---
title: "What does FAQ stand for?"
alt_titles:
  - "What is the meaning of FAQ?"
  - "What does FAQ mean?"
---

FAQ stands for *Frequently Asked Questions*

文件名不重要，但必须有一个title。您还可以可选地添加在alt_titles下的替代标题，这些标题将与faqtory suggest功能一起使用（但不会显示）。

构建

运行以下命令来构建FAQ

faqtory build

使用默认设置，这将生成一个FAQ.md文件。

建议

“建议”子命令可以编译一个与提供的标题匹配的FAQ条目列表。以下是一个示例

faqtory suggest "who is the author of FAQtory?"

这将生成FAQ中匹配的条目列表，并将Markdown写入标准输出。您可以使用您“.faq/”目录中的“suggest.md”模板（如果您没有在其他地方配置它）修改输出，

此功能旨在与GitHub操作一起使用以发布自动响应。要启用此功能，将new_issue.yml复制到您的存储库中具有类似名称的目录。

免责声明

这是一个维护者匆忙制作出来的工具，因为他厌倦了回答相同的老问题。我无法投入太多时间在这个项目上，但我将很高兴接受PRs！