styleguidist/react-styleguidist

Configure Sections using markdown files in folders and front-matter

Open

#365 创建于 2017年3月29日

在 GitHub 查看
 (13 评论) (0 反应) (0 负责人)TypeScript (1,416 fork)github user discovery
help wantedrequest for comments

仓库指标

Star
 (11,091 star)
PR 合并指标
 (PR 指标待抓取)

描述

I know we can configure sections via a custom config.

But wouldn't it be cool if the sections could be generated simply by [index|section].md files in src folders using YAML front matter (https://github.com/matthewwithanm/markdown-with-front-matter-loader)?

---
section: Name of the section
---

# Section description

This would further simplify the configuration. What you think?

贡献者指南

研究方向
查看 react styleguidist 目前如何处理章节配置。然后探索使用类似 markdown with front matter loader 的加载器或直接读取文件来解析带有 front matter 的 markdown 文件。考虑如何将其与现有配置机制集成。
技术栈
typescriptreactjavascript
领域
frontend
议题类型
功能
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
半天
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
MarkdownYAMLReact
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
60