Add an integrated documentation website

未關閉
#2 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

評估

難度
5/5
預估耗時
一週以上
新手友好度
25/100
Issue 類型
功能
描述清晰度
需要釐清
活躍度
停滯
技術堆疊
typescript

研究方向

先檢視儲存庫結構和現有的 TypeScript 套件工作流程,以確定整合式文件網站可以放在哪裡。在實作之前,定義部署方式、Markdown 和程式碼片段支援、擴充模型以及登陸頁面範圍;當各個 fork 能夠為其套件部署並自訂文件網站時,即表示完成。

由索引模型根據 Issue 內容生成。

描述

A documentation website baked into the stack so forks can:

  • Deploy it for free
  • Document the open-source package
  • Have a way to support md and code snippets so they can showcase examples
  • Allow easy extension
  • Add cool landing page?
主要語言
TypeScript
星號
121
分支
11
PR 合併指標
30 天內沒有已合併 PR

環境準備

  • 沒有 Dockerfile 或 Docker Compose 檔案
  • 有 Pull Request 範本
  • 沒有貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

相似的 Issue

更多 TypeScript Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。