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

New documentation forms #1702

Open
KermanX opened this issue Jun 25, 2024 · 0 comments · May be fixed by #1706
Open

New documentation forms #1702

KermanX opened this issue Jun 25, 2024 · 0 comments · May be fixed by #1706
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request needs discussion

Comments

@KermanX
Copy link
Member

KermanX commented Jun 25, 2024

Intro
Currently, Slidev's documentation is organized as articles. This is suitable for most of the projects.
However, for Slidev, many of the features are independent of each other. Grouping them into articles makes them less readable.
Also, tons of features that are not necessarily for newcomers to Slidev may scare them away, which I think is one of the largest problems - Other web-based slides-making tools have simpler docs, though Slidev itself can be as simple to use as them.

Solution
The docs can be divided into two parts:

  1. Guide: organized as articles
  • Installation
  • Basic syntax
  • Animation (Clicks system...)
  • Presenter mode
  • Overview page
  • Recording
  • Editor
  • Exporting
  • Hosting
  1. Features: organized as cards
  • Code blocks line number
  • Code block max height
  • Shiki magic move
  • Twoslash integration
  • Monaco editor
  • Runnable Monaco editor
  • Writable Monaco editor
  • ...

Note that both the guide and features should have links to the related guide/features. e.g., in the Animation Guide, details about the clicks system won't be covered. Instead, it should provide links to them. The linked content can be previewed by hovering over the link.

@KermanX KermanX added documentation Improvements or additions to documentation enhancement New feature or request needs discussion labels Jun 25, 2024
@KermanX KermanX self-assigned this Jun 25, 2024
@KermanX KermanX linked a pull request Jun 27, 2024 that will close this issue
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 enhancement New feature or request needs discussion
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant