Skip to content

[Feature]: Interactive CLI Preview for Documentation #4

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

Open
dreyfus92 opened this issue Apr 7, 2025 · 2 comments
Open

[Feature]: Interactive CLI Preview for Documentation #4

dreyfus92 opened this issue Apr 7, 2025 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@dreyfus92
Copy link
Member

Description

We've discussed the idea of adding interactive CLI previews within our documentation to showcase the beautiful rendering of prompts provided by Clack. Currently, static terminal output examples are helpful but might become cumbersome to maintain due to the differences in terminal setups and colors between contributors.

Proposed Solution

Short-Term: Continue using static CLI output examples captured manually (as per PR #3).

Long-Term: Develop an Astro component that dynamically renders examples. Eventually, integrate a fully interactive terminal using libraries like @webcontainers/core and xterm.js.

@dreyfus92 dreyfus92 added help wanted Extra attention is needed documentation Improvements or additions to documentation enhancement New feature or request labels Apr 7, 2025
@natemoo-re
Copy link
Member

A while back I built an implementation of this for the clack.cc site. Code is pretty old and could probably be refactored, but the basics are there for reference. https://github.com/natemoo-re/clack.cc/blob/main/src/components/Terminal

@MacFJA
Copy link
Contributor

MacFJA commented Apr 14, 2025

Another solution is the usage of Asciinema like in #8

It's a middle ground solution, you can not interact with the console, but you have a replay of what a real scenario is.
So it's not static, but not truly interactive either

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 help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants