Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

【官网优化】Readme需要构建中文版本 #23

Closed
Genluo opened this issue Mar 22, 2021 · 3 comments
Closed

【官网优化】Readme需要构建中文版本 #23

Genluo opened this issue Mar 22, 2021 · 3 comments
Assignees
Labels
enhancement New feature or request

Comments

@Genluo
Copy link
Member

Genluo commented Mar 22, 2021

针对这个问题是够可以和Typedoc进行一些共建,不需要做成单点的功能,首先需要Typedoc的issue中找下,看下有没有相似的问题

@Genluo Genluo added the enhancement New feature or request label Mar 22, 2021
@Genluo Genluo self-assigned this Mar 22, 2021
@Genluo
Copy link
Member Author

Genluo commented Mar 29, 2021

利用TypeDoc的官网解决这个问题:

Another possible solution here:

  1. fork https://github.com/TypeStrong/typedoc-site and put your markdown doc in its _guides folder
  2. put your compiled typedoc output to api folder
  3. customize it for your project and release the whole jekyll site

Not much extra work required but get a perfectly look and unhacky results.

@Genluo
Copy link
Member Author

Genluo commented Mar 29, 2021

通过三方插件方式解决

I wrote a TypeDoc plugin that I think might solve this need:
https://github.com/mipatterson/typedoc-plugin-pages
Live demo here

@Genluo
Copy link
Member Author

Genluo commented Mar 30, 2021

对应的issue地址

@Genluo Genluo closed this as completed Dec 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant