Skip to content

Latest commit

 

History

History
81 lines (59 loc) · 2.35 KB

readme.md

File metadata and controls

81 lines (59 loc) · 2.35 KB

Microsite GitHub Banner

Opinionated micro front-end that can be used to create a one-pager. Great for landing pages or sign-up pages. It uses the static site generator Eleventy (11ty) under the hood and sets common 11ty defaults.

Features ✨

This is a *skeleton project so it doesn't include any components or basic styling. It's a *bring your own front-end.

Usage

  1. Update the metadata.json file with your own site details
  2. Edit the index.njk file and start coding your website!
  3. Optional: Deploy the site to Netlify.

Install

Requires node.js and npm

Follow these steps to get started:

  1. Clone the project
$ git clone https://github.com/systemdes/micro-site.git
  1. Install the dependencies for this projects
npm i
  1. Then do
npm run dev

to start the live-reloadzz on a local development server.

Project Structure

micro-site/
├── _site/                // output folder of 11ty
├── _data/
│   └── metadata.json     // metadata for the website
├── _includes/
│   ├── style.css         // minified and inlined
│   ├── script.js         // minified and inlined
│   └── base.njk          // base layout
├── assets/               // passtrough copy
├── index.njk/            // landing page
└── .eleventy.js          // 11ty configurations

Roadmap

  • Image optimization with eleventy-image
  • Asset caching with eleventy-cache-assets
  • Syntax highlighting support with eleventy-plugin-syntaxhiglight

License

MIT © Danny de Vries