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

Use Vitepress #14

Open
abiriadev opened this issue Jun 4, 2024 · 1 comment
Open

Use Vitepress #14

abiriadev opened this issue Jun 4, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@abiriadev
Copy link
Owner

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.
@abiriadev abiriadev added the documentation Improvements or additions to documentation label Jun 4, 2024
@abiriadev abiriadev self-assigned this Jun 4, 2024
@abiriadev
Copy link
Owner Author

  1. Generate markdown or Vue code from typedoc JSON output.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Todo
Development

No branches or pull requests

1 participant