sidebar/setup

Managing sidebar with its peer content without hassle 🤘: a layout handles the sidebar in different breakpoints, the transition between them, and more.

Steps

1️⃣ Make sure you have finished the global setup:

If you haven't, please do so.

2️⃣ Install vendor dependencies:

🔄Analyzing which dependencies need to be installed...

3️⃣ Install component:

Learn how to use "Save Source Files" correctly if this is your first time

This is VERY DIFFERENT from traditional "installation" because we use the File System API.

Your browser will ask for permission—just accept all the prompts, and the files will be saved directly to your local folder (no zip file involved). That’s why you can use the component immediately.

The "source files" are just one or more "component folders". Currently, We don’t recommend renaming these folders or moving the files, as this could break best practices and may cause issues with future updates

If you're curious why we use this API, the simple answer is: because we adopt a VPM (Virtual Package Management) approach.

Explaining all the details would require a full article, but in short: with VPM, you can’t use NPM commands to install the component. So how do you use it?

One way is to create a CLI tool to do the work, but that means you need to learn more tools, and it can be more complicated than you expect depending on your development environment. That can be frustrating!

That’s why we use the File System API: with just a few clicks—often only one—the component will be added to your project. It’s incredibly easy!

You might ask, "But does using that API mean it can download the component regardless of the development environment's complexity?"

We’ve found this approach works much better overall. While there are still some edge cases, the feature is evolving and should cover most needs. In the future, we’ll also use this API to make it easy for you to receive updates to components and related files.

Dependencies

Loading dependencies...