-
Notifications
You must be signed in to change notification settings - Fork 61
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
migrate from mdbook to docusaurus #166
Comments
@zhangyangyu thanks for starting this thread! Could you also add a link to the sample page? Although I agree that mdBook is lack of smooth TOC as well as font / color configuration, there are too many doc / blog systems to try out. I'd like to prevent we just move from one to the other but later figure out new problems. |
The try is a local site. But it uses the default theme of docusaurus so it should be nothing different from the docusaurus tutorial. Yes, too many doc/blog systems. Actually docusaurus gives its subjective comparisons with other popular systems. docusaurus is not a must for me. I just think its out-of-box installation could solve mdbook's problems and it's actively maintained. |
Currently the dev guide uses mdbook. But from my reading experience there are two problems: 1. the theme makes me feel bored and tired quickly, lacking color contrast; 2. no ToC (this is not supported by mdbook builtin). I'd like to propose docusaurus as the doc system. It could solve the two problems and it's actively maintained. There are already many sites hosted by it.
A preliminary try is like:
But due to the lack of category index page, we might need to wait several days still. Although I think the category pages of contribute to TiDB and get started are somehow redundant but the page of understand TiDB is valuable.
The text was updated successfully, but these errors were encountered: