You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Clone the project locally: git clone https://github.com/solidjs/solid-site
Change directory into your local copy: cd solid-site
Install the dependencies: pnpm i
Available commands
pnpm i: Install the dependencies
pnpm dev: Start the dev server
pnpm build: Build the project
pnpm build:sitemap: Generate the sitemap.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
PWA Testing
Solid Site supports PWA and worker auto updating powered by Vite PWA Plugin. When testing run pnpm https-preview. Running it the first time will ask to install the certificate if not yet done. Then open your Chrome and press F12 > Network Tab > browse to https://localhost. Wait until the network requests with gears at the begining stops downloading the SW precache, then on the same Network Tab just change No throttling option to Offline. All pages should work by pressing F5 (do not do a hard refresh Ctrl + F5 as it will force the browser to go to the server and the Chrome Dinosaur will appear).
Additional information
How do the documentation files work?
They're imported from the Solid Docs package. There's a script there that builds the markdown files into consumable JSON files, and the package provides functions to load them.
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.
Sponsors
Thank you to our generous and helpful sponsors. If you're interested in sponsoring Solid, reach out to us on Discord.