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