Solid Site

Overview:

The Solid website is built with SolidJS, a reactive JavaScript UI library, and styled using TailwindCSS. It supports Progressive Web App (PWA) and worker auto-updating powered by Vite PWA Plugin. The documentation files are imported from the Solid Docs package. Contributions to the website are accepted via well-structured pull requests.

Features:

• SolidJS Framework: Built with the SolidJS reactive JavaScript UI library.
• TailwindCSS Styling: Styled using TailwindCSS for a modern look and feel.
• PWA Support: Progressive Web App support with worker auto-updating powered by Vite PWA Plugin.
• Documentation Integration: Documentation files are imported from the Solid Docs package.
• Contributions: Actively accepting contributions via well-structured pull requests.
• Dependency Management: Uses pnpm as the package manager.
• Code Highlighting: Code highlighting is implemented using Shiki.
• Deployment Tools: Cloudflare Wrangler is used for deployment to Workers.

Installation:

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
   

4. Available commands:

   • 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

Summary:

The Solid website showcases the capabilities of the SolidJS framework, styled with TailwindCSS, and with support for PWA functionality. It provides detailed documentation obtained from the Solid Docs package and encourages contributions from the community. The use of pnpm as the package manager, Shiki for code highlighting, and Cloudflare Wrangler for deployment adds to its appeal for developers.