invertase / invertase/docs.page

Feature: `FileTree` Component

Open
#397 0 comments 0 reactions 0 assignees View on GitHub
status: discussion
Dominant language
TypeScript
Stars
673
Forks
101
Avg merge
4d 5h
Merged PRs (30d)
10

Description

Currently the easiest way _(excluding custom components)_ to visualize a directory structure is to use an ascii-based tree as follows:

```
your_app/
├── pubsepc.yaml
├── lib/
├── ...
└── widgetbook/
├── pubsepc.yaml
├── lib/
└── ...
```

Providing first-class support for this might be a good idea, to make docs more visually appealing.
Here are some examples:

1. [Nextra's `FileTree`](https://nextra.site/docs/guide/built-ins/filetree) - Simple and interactive file tree.
![image](https://github.com/user-attachments/assets/0001dcd5-b4d2-476b-bbee-8c8805265915)

1. [From Next.js docs](https://nextjs.org/docs/app/building-your-application/routing/pages-and-layouts) - They have a more visually appealing style, they use images instead of components to be able to annotate their images.
![image](https://github.com/user-attachments/assets/76d0d992-41ef-443e-93d9-643530a3ef68)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.