Skip to content

[Feature][RuntimeComponent]: Support <Files /> #2154

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
SoonIter opened this issue May 13, 2025 · 1 comment
Open

[Feature][RuntimeComponent]: Support <Files /> #2154

SoonIter opened this issue May 13, 2025 · 1 comment
Labels
💡 good first issue Good for newcomers

Comments

@SoonIter
Copy link
Member

SoonIter commented May 13, 2025

What problem does this feature solve?

Image

In order to better print file tree information

```sh
docs
├── en
│   ├── _meta.json // navigation bar level
│   └── guides
│       ├── _meta.json // sidebar level
│       ├── introduction.mdx
│       ├── install.mdx
│       └── advanced
│           ├── _meta.json // sidebar level
│           └── plugin-development.md
└── zh
    ├── _meta.json // navigation bar level
    └── guides
        ├── _meta.json // sidebar level
        ├── introduction.mdx
        ├── install.mdx
        └── advanced
            ├── _meta.json // sidebar level
            └── plugin-development.md
```

"shell script" code block is not for printing file tree, but it is used commonly in prism

This will cause this part of the code is very ugly when users switch to shiki, the best solution to this issue is to provide a component to meet this part of needs

What does the proposed API look like?

https://fumadocs.dev/docs/ui/components/files

import { File, Folder, Files } from 'rspress/theme';
import { File, Folder, Files } from '@rspress/theme-default';
@SoonIter SoonIter added the 💡 good first issue Good for newcomers label May 13, 2025
@SoonIter SoonIter changed the title [Feature]: Support <Files /> [Feature][RuntimeComponent]: Support <Files /> May 13, 2025
@JounQin
Copy link
Collaborator

JounQin commented May 13, 2025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💡 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants