Skip to content

Proposal: use vitepress to generate documentation site #3905

@marcalexiei

Description

@marcalexiei

Recently I found out that all vite ecosystem docs are powered by vitepress.
Here is the official site: https://vitepress.dev

Even if it is not released yet, it's on rc status right now, it looks pretty good looking and solid to me.

Another library that relies on vitepress for docs is husky: https://typicode.github.io/husky/


Some of the features that might benefit the docs are:

  • code groups: we can use tabs to show different command based on OS or package manager.
  • alert variants: right now there aren't many variants available

You can see more examples here: https://vitepress.dev/guide/markdown

docsify doesn't offer such features by default, you have to include additional scripts.

Since we are migrating to vitest on #3850 I think that having documentation powered by the same ecosystem
could be a good benefit.


What do you thing about it?
If you agree I'm more than willing to setup a PR!
Before proceeding I will wait merge of #3850 to avoid conflicts

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions