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 摘要。