denodev / typedoc

Deno API - Simplified Chinese

Deno API 简体中文版

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

本文档使用了 typedoc-deno-theme 主题和 typedoc-plugin-deno 插件，为文档提供了中英文对照功能。

实用命令

• yarn format: 整理文件格式。所有文件格式均使用 prettier 的默认配置。如果没有特殊必要，你基本上不需要手动运行此命令。当 git commit 的时候此命令会自动运行。
• yarn build: 生成 typedoc 文件。你可以通过在浏览器中打开 ./typedoc/index.html 来预览最终的生成效果。

参与翻译

翻译规范请参阅中文文案排版指北

• 参与翻译
• 翻译进度

版权许可

本文档采用 CC BY-NC 4.0 许可协议。

typedoc's Issues

参与翻译

首先，感谢你参与本文档的建设。

本文是一篇针对首次参与开源项目的开发者编写的一份简易教程，本文档更偏重于翻译文档而非贡献代码。

1. fork 仓库

大部分情况下，你是没有本仓库的 write 权限的，因此你需要 fork 本仓库。

点击右上角的 fork 按钮。你的本地仓库地址是：

https://github.com/xxxxxx/typedoc

其中 xxxxxx 是你的用户名。

2. clone 到本地

注意，千万不要 clone 这个仓库(denodev/typedoc)，因为你没有 push 权限。你需要 clone 自己已经 fork 完的仓库。

有 2 种 clone 方式：HTTPS 和 SSH。推荐使用 SSH 方式，这需要你先添加 [SSH keys]((https://github.com/settings/keys)。

git clone [email protected]:xxxxxx/typedoc.git

其中 xxxxxx 是你的用户名。默认分支为 master。

如果你想长期参与本项目，推荐你添加一个针对上游仓库(denodev/typedoc)的跟踪：

git remote add upstream https://github.com/denodev/typedoc.git

同步：

git checkout master
git fetch upstream -ap
git rebase upstream/master

3. 翻译

在翻译之前，你应该在 Pull Requests/Issues 页面看看其他开发者正在进行的工作，以防止重复翻译。

不推荐直接在 master 分支进行翻译。

推荐每次翻译之前新建一个功能分支，比如翻译 Deno.cwd 可以新建分支 deno-cwd:

git checkout master
git checkout -b deno-cwd
git push -u origin deno-cwd

如果你的翻译任务可以持续很长时间，你应该提一个 Merge Request。选择 Draft PR：

标题和描述里面写清楚你正在进行的工作，防止重复工作。当翻译完成后，点击 Ready for view:

4. 完成

提完 PR 后其他开发者会对你的翻译进行 review。

5. 注意

如果你是第一次参与翻译，可以查看 good first issue，我会使用这个标签来标记一些优秀的案例。

致谢

感谢所有参与翻译工作的开发者们。

deno 的标准库是否有计划进行翻译？

我看现在翻译的是 Deno 命名空间下的属性或者方法，想参与翻译一些，但是已经完成了啊。那么 是否有计划对标准库进行翻译？

若有计划，我这边可以贡献一部分力量

翻译进度(100% v0.41.0)

• pid aabdc74
• noColor aabdc74
• TestDefinition
• test(x3) #42
• TestMessage
• RunTestsOptions #50 #64
• runTests
• loadavg
• hostname #28
• osRelease #16
• exit #27
• env(x2) #23
• DirKind
• dir
• execPath #26
• cwd #41
• chdir #22
• umask
• EOF
• SeekMode
• Reader #17
• SyncReader
• Writer #65
• SyncWriter #65
• Closer
• Seeker
• SyncSeeker
• ReadCloser
• WriteCloser
• ReadSeeker
• WriteSeeker
• ReadWriteCloser
• ReadWriteSeeker
• copy #45
• toAsyncIterator
• openSync(x2) #49
• open(x2) #49
• createSync #46
• create #46
• readSync
• read
• writeSync #44
• write #44
• seekSync
• seek
• close #33
• File #51
• stdin
• stdout
• stderr
• OpenOptions
• OpenMode #47
• isatty
• setRaw
• Buffer #18
• readAll
• readAllSync
• writeAll
• writeAllSync
• MkdirOptions
• mkdirSync/mkdir #19 #20
• MakeTempOptions #54
• makeTempDirSync
• makeTempDir
• makeTempFileSync #54
• makeTempFile #54
• chmodSync/chmod(x2)
• chownSync
• utimeSync/utime
• RemoveOptions #25
• removeSync/remove #24
• renameSync/rename
• readFileSync/readFile #56 #57
• FileInfo
• realpathSync/realpath #29
• readdirSync/readdir #31
• copyFileSync/copyFile #30
• readlinkSync/readlink #32
• lstatSync/lstat #34
• statSync/stat #35
• linkSync/link #36
• symlinkSync/symlink #37
• WriteFileOptions #38
• writeFileSync/writeFile #39
• Location
• applySourceMap
• errors
• PermissionName #40
• PermissionState #40
• RunPermissionDescriptor
• ReadWritePermissionDescriptor
• NetPermissionDescriptor
• EnvPermissionDescriptor
• PluginPermissionDescriptor
• HrtimePermissionDescriptor
• PermissionDescriptor #40
• Permissions #40
• permissions #40
• PermissionStatus #40
• truncateSync/truncate #53
• AsyncHandler
• PluginOp
• Plugin
• openPlugin
• NetAddr
• UnixAddr
• Addr
• ShutdownMode #43
• shutdown #43
• DatagramConn
• Listener
• Conn
• ListenOptions
• UnixListenOptions
• listen(x4)
• ListenTLSOptions
• listenTLS
• ConnectOptions #62
• UnixConnectOptions
• connect #52
• ConnectTLSOptions
• connectTLS
• Metrics #60
• metrics #60
• ResourceMap 353fbda
• resources #61
• FsEvent
• fsEvents
• ProcessStdio
• kill
• Process #55
• ProcessStatus
• RunOptions
• run
• Signal
• InspectOptions
• inspect
• OperatingSystem
• Arch
• BuildInfo #66
• build #66
• Version
• version
• DiagnosticCategory
• DiagnosticMessageChain
• DiagnosticItem
• Diagnostic
• formatDiagnostics
• CompilerOptions #68
• TranspileOnlyResult
• transpileOnly
• compile
• bundle
• args #12
• SignalStream #59
• signal #59
• signals #59
• symbols #58

Error: The partial literal could not be found