kylesloper / discord-viteeleventy

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

ethical design ethical design

atmos

Contents

  1. Quickstart 🔥
  2. Features
  3. Overview
  4. About
  5. Removing Tailwind
  6. Bug reports

Quickstart 🔥

1. Clone this repository

git clone https://github.com/moonfacedesign/atmos project-name

2. Navigate to your project

cd project-name

Check over .eleventy.js to see if you want to configure any Eleventy options differently.

3. Install required dependencies

npm install

4. Update site metadata

Edit values in _data/site.json

5. Start local development server

npm run start

This will run on localhost:8080

You can also run npm run build to build your project

6. Deploy

Set these as your build settings:

build command          npm run build
publish directory      .www

Add these environments:

ENVIRONMENT   production
NODE_ENV      production

Features

  • Built with Eleventy
  • 100's across the board with lighthouse
  • SPA functionality with tabs
  • Progressive Web App
  • Service Worker for offline use
  • Styling with TailwindCSS
  • Tailwind JIT for fast styles generation
  • CSS minification, inlined for fastest page render
  • Maintenance-free post author archives
  • Default pages including blog with tag support
  • Netlify contact form
  • Optional pipeline for minified inline JS
  • Pre-builds and minifies your HTML
  • Uses Markdown files for content
  • Uses Nunjucks templates for layouts
  • Complies with our Ethical Design Guidelines
  • 100% Javascript framework free

Overview

Structure

  • components - Partials & macros Eleventy's components (default name is _includes)
  • layouts - Pages & Sub-pages layouts
  • .www - Built site. This is your publish directory when deploying (default name is _site)
  • _data - For all Global data files
  • pages - All of your site's pages in markdown
  • posts - An example collection used in the blog
  • scripts - All scripts used by your site
  • styles - All styles used by your site. This is also where the Tailwind config is
  • static - All static content: images, fonts, video, audio etc
    • images - All images used by your site
    • type - All fonts used by your site
  • 404.md - Custom 404 page for production
  • author.njk - Author page pagination
  • authors.njk - Author directory page
  • sitemap.njk - Automatic sitemap for production
  • tags.njk - Tags page pagination

Styling

TailwindCSS powers atmos' styling by default. You can learn how to remove it here.

  • styles - All styles used by your site. This is also where the Tailwind config is
    • tailwind.config.js - Tailwind config file
    • tw.css - Tailwind styles
    • _output.css - Processed Tailwind output styles

Sitemap

atmos automatically generates a sitemap from your content. This is found in sitemap.njk and is processed into a xml file during build.

Service worker

atmos is a Progressive Web App which means that is is optimized for mobile use. The service worker in atmos allows for your project to be cached by the humans browser so they can view your site offline; this allows for a better mobile experience.

About

We use atmos for our Eleventy projects because it houses everything we need to create a performant site. atmos does not claim to be the smallest nor to being the easiest boilerplate to get started with, we created atmos to work alongside the Moonface workflow and if it fits your project then that's just amazing!

Removing Tailwind

By default atmos uses TailwindCSS to generate styles. We understand that Tailwind is not for everyone and that in some projects it may be easier to return to css or sass. Here's how you would go about that:

  1. Remove Tailwind from your npm scripts
  2. Uninstall tailwindcss, postcss and autoprefixer
  3. Remove this from .eleventy.js
  if (!process.env.ELEVENTY_ENV) {
  eleventyConfig.addPassthroughCopy({ './styles/_output.css': '/styles/tw.css' });
}
  1. Remove this from components/head.njk
  {% if env.environment == "production" %}
{% set css %}
  {% include "styles/_output.css" %}
{% endset %}
<style>{{ css | cssmin | safe }}</style>
{% else %}
  <link rel="stylesheet" href="/styles/tw.css">
{% endif %}

And replace with:

  {% set css %}
  {% include "styles/your-styles.css" %}
  {% endset %}
  1. Delete the tailwind.config.js and you should be all set!

Bug reports/help 👋

If you need any help or want to file a bug report, contact the Lead developer.

moonface

About

License:Apache License 2.0


Languages

Language:Nunjucks 57.8%Language:CSS 36.9%Language:JavaScript 5.3%