Repository files navigation

This is the source code for the solid website:https://solidjs.com/

The website is built withSolid. In order to get going, you should be familiar with the core API of Solid and how it works on the surface.

• pnpm

1. Clone the project locally:git clone https://github.com/solidjs/solid-site
2. Change directory into your local copy:cd solid-site
3. Install the dependencies:pnpm i

• pnpm i: Install the dependencies
• pnpm dev: Start the dev server
• pnpm build: Build the project
• pnpm build:sitemap: Generate thesitemap.xml file
• pnpm format: Format the whole project with prettier
• pnpm deploy:dev: Helper method to deploy to dev
• pnpm deploy:prod: Helper method to deploy to prod

Solid Site supports PWA and worker auto updating powered by Vite PWA Plugin. When testingrun pnpm https-preview. Running it the first time will ask to install the certificate if not yet done. Then open your Chrome and pressF12 > Network Tab > browse tohttps://localhost. Wait until the network requests with gears at the begining stops downloading the SW precache, then on the same Network Tab just changeNo throttling option toOffline. All pages should work by pressingF5 (do not do a hard refreshCtrl +F5 as it will force the browser to go to the server and the Chrome Dinosaur will appear).

They're imported from theSolid Docs package. There's a script there that builds the markdown files into consumable JSON files, and the package provides functions to load them.

• SolidJS - Reactive Javascript UI library
• TailwindCSS - For all the styles
• Cloudflare Wrangler - Cloudflare Wrangler to deploy to Workers
• Vite - For the bundler / dev server
• pnpm - The package manager
• Shiki - For the code highlight
• Vite PWA - For PWA functionality

We are actively accepting contributions to improve the Solid website. We accept PRs that are well-structured, have formatting applied and follow the general structure of the site. If you have any questions, want to report a bug or a general concern, feel free to reach us on GitHub Issues or Discord.

Thank you to our generous and helpful sponsors. If you're interested in sponsoring Solid, reach out to us on Discord.

• Cloudflare
• Netlify
• Builder.io
• SauceLabs