abiriadev/seia

Use Vitepress

Opened this issue · 1 comments

Problem

The current documentation is typedoc, which is not user-friendly as a guide.

Solution

Use Vitepress as a document generator so that we can provide more human-readable guides about installing, running the server, configuring, etc.

Further works

How can we integrate both typedoc and vitepress?

Currently, there are two options:

  1. Generate markdown or Vue code from typedoc JSON output.
  2. Use a subdomain, like api.seia.dev and provide a direct link to typedoc from vitepress.
  1. Generate markdown or Vue code from typedoc JSON output.

Maybe we can use typedoc-plugin-markdown to generate markdown code?