https://github.com/denodev/typedoc

Deno API - Simplified Chinese
https://github.com/denodev/typedoc

deno typedoc typedocs typescript

Last synced: 3 months ago
JSON representation

Deno API - Simplified Chinese

• Host: GitHub
• URL: https://github.com/denodev/typedoc
• Owner: denodev
• Created: 2020-04-12T02:55:22.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-06-29T01:07:02.000Z (over 1 year ago)
• Last Synced: 2024-08-03T09:09:18.958Z (6 months ago)
• Topics: deno, typedoc, typedocs, typescript
• Homepage:
• Size: 2.71 MB
• Stars: 139
• Watchers: 10
• Forks: 22
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-deno-cn - @denodev/typedoc

README

        
# Deno API 简体中文版

[![Build Status](https://github.com/denodev/typedoc/workflows/ci/badge.svg?branch=master)](https://github.com/denodev/typedoc/actions)

[![license](https://img.shields.io/github/license/denodev/typedoc)](https://github.com/denodev/typedoc/blob/master/LICENSE)

[![](https://img.shields.io/badge/deno-v0.41.0-green.svg)](https://github.com/denoland/deno)

Deno 简体中文 API 参考手册。本文档是非官方 Deno 简体中文文档，由中文开发者社区的志愿者们维护。

本文档使用了 [typedoc-deno-theme](https://github.com/denodev/typedoc-deno-theme) 主题和 [typedoc-plugin-deno](https://github.com/denodev/typedoc-plugin-deno) 插件，为文档提供了中英文对照功能。

## 实用命令

- `yarn format`: 整理文件格式。所有文件格式均使用 prettier 的默认配置。如果没有特殊必要，你基本上不需要手动运行此命令。当 `git commit` 的时候此命令会自动运行。

- `yarn build`: 生成 typedoc 文件。你可以通过在浏览器中打开 `./typedoc/index.html` 来预览最终的生成效果。

## 参与翻译

翻译规范请参阅[中文文案排版指北](https://github.com/sparanoid/chinese-copywriting-guidelines)

- [参与翻译](https://github.com/denodev/typedoc/issues/4)

- [翻译进度](https://github.com/denodev/typedoc/issues/6)

## 版权许可

本文档采用 [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/deed.zh) 许可协议。