Nuclear Pumpkin Mocha

    microsite
    TypeScript icon, indicating that this package has built-in type declarations

    1.1.0 • Public • Published


    microsite

    Read the docs | See the live examples | Join our Discord



    microsite is a fast, opinionated static-site generator (SSG) built on top of Snowpack. It outputs extremely minimal clientside code using automatic partial hydration.

    npm init microsite

    Microsite is an ESM node package, so it needs to run in a Node environment which supports ESM. We support the latest version of node v12.x LTS (Erbium) — see Engines for more details.

    Ensure that your project includes "type": "module" in package.json, which will allow you to use ESM in your project's node scripts.

    Pages

    Microsite uses the file-system to generate your static site, meaning each component in src/pages outputs a corresponding HTML file.

    Page templates are .js, .jsx, or .tsx files which export a default a Preact component.

    Styles

    Styles are written using CSS Modules. src/global.css is, as you guessed, a global CSS file injected on every page. Per-page/per-component styles are also inject on the correct pages. They are modules and must be named *.module.css.

    Project structure

    project/
    ├── public/             // copied to dist/
    ├── src/
    │   ├── global/
    │   │   └── index.css   // included in every generated page
    │   │   └── index.ts    // shipped entirely to client, if present
    │   ├── pages/          // fs-based routing like Next.js
    │   │   └── index.tsx
    └── tsconfig.json
    

    Acknowledgments

    Keywords

    none

    Install

    npm i microsite@1.1.0

    Version

    1.1.0

    License

    MIT

    Unpacked Size

    150 kB

    Total Files

    53

    Last publish

    Collaborators

    • natemoo-re