Skip to content

migrate from mdbook to docusaurus #166

@zhangyangyu

Description

@zhangyangyu

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:
image

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions