Solid Docs

Welcome to Solid's documentation!

This is the repo for docs.solidjs.com. This repo contains all the source code that we use to build our docs.

What is Solid?

Solid is a JavaScript framework used for building high-performance user-interfaces. Using a reactive approach and component-based architecture, we want to empower developers in creating efficient and scalable web applications.

Thank you for being here!

You can help make our docs better for the community! Your feedback is welcomed. In addition, any editing, translating, designing, and developing skills are welcomed. We are grateful to welcome you into our community!

If you want to see how you can contribute, check out our How You Can Help section.

Chat with us

You can learn more about Solid, get support, and meet other devs and contributors in our Discord community.

Raise an issue

Have you noticed something is missing, confusing, or is wrong in our documentation?

Check to see if it has already been mentioned and, if not, create an issue to bring it to our attention!

Share an idea

Do you think something could be better? Have an idea you feel could make the docs better?

Discussion threads are where you can offer feedback on things that might not be problems that need addressing, but are ideas to be explored.

Join us in the Discussions section where we can brainstorm these ideas, ask questions, and share goals!

Suggest a fix or contribute

Have you found a typo, broken link, or another item with an obvious quick fix?

If you can see what the problem is, and you know how to fix it, you can make a PR (pull request) with the change and contribute to the docs repo yourself.

If you're looking to make a larger contribution, please see our CONTRIBUTING.md first!

Running the Site Locally

At the moment, we recommend running the site locally through either CodeSandbox, Gitpod, or StackBlitz. These are the quickest and easiest way to browse and edit the project files and run the site locally.

The app uses pnpm as the package manager and it runs on Node.js v18+.

Install dependencies:

pnpm i

And run the local dev server:

pnpm dev

This will start your the app at localhost:3000 or the next available port.

Collections and virtual modules

The builds an Astro inspired collection navigation, it will bring all routes and generate a couple of files at /.solid. These files are exposed to your app via Vite virtual modules. This task is perform via our sync script (pnpm sync), ran before every build.

If changes are made to the navigation (new entry, or repositioning entry), it is necessary to restart the server for changes to take effect.

Rabbitminers/solid-docs

ErrorLooks like something went wrong!

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Error
Looks like something went wrong!

Packages