README.md

Solid Mobile Docs

Documentation site for solid-mobile — a mobile UI component library for Solid.js.

This is an independent project: it consumes solid-mobile as a real npm package, never as source code. If a demo renders correctly here, the published package works for users.

• 🖥️ Live site: https://lxg19961206.github.io/SolidMobile-Docs/
• 🐙 Library repo: https://github.com/LXG19961206/SolidMobile

Development

npm install
npm run dev        # localhost:3000

To preview unreleased library changes, build the library first, then install the tarball without touching package.json:

# in the library repo
npm run build && npm pack          # → solid-mobile-x.y.z.tgz

# in this repo
npm install --no-save --no-package-lock ../SolidMobile/solid-mobile-x.y.z.tgz

Deploy

npm run build produces dist/; the GitHub Actions workflow deploys it to GitHub Pages on every push to main.

Structure

components/   Per-component doc page + mobile demo + i18n
doc-utils/    Shared docs UI (layout, code blocks, phone simulator)
pages/        Route pages (guide, mobile home)
lib/          Small utilities copied from the library (not in its public API)