Skip to content
PWA starter built for internationalization
JavaScript CSS HTML
Branch: master
Clone or download
Snugug Merge pull request #14 from chromeos/degit-globs
Add CI testing with GitHub Actions
Latest commit e67fbae Jan 14, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github 💚 Add Lighthouse assertions and URLs Jan 14, 2020
config 📦 Bump static-site-scaffold and eleventy Jan 14, 2020
src ♻️ Move to separated modules Jan 14, 2020
templates 💚 Fix failing Lighthouse audits Jan 14, 2020
tests 💚 Add GitHub Action for build, test, and Lighthouse Jan 14, 2020
views 💫 Change generated components folder Dec 17, 2019
.editorconfig 🎉 Initial Commit Sep 11, 2019
.eleventy.js 🐛 Fix eleventy config export Jan 6, 2020
.eslintrc.yml 🎉 Initial Commit Sep 11, 2019
.firebaserc 🆕 Include project config in firebaserc Nov 8, 2019
.gitignore 🎉 Initial Commit Sep 11, 2019
.npmrc 🔧 Don't include package-lock.json for scaffold Oct 1, 2019
.nvmrc 💚 Add GitHub Action for build, test, and Lighthouse Jan 14, 2020
.prettierrc 🎉 Initial Commit Sep 11, 2019
.sass-lint.yml 🎉 Initial Commit Sep 11, 2019
CODE_OF_CONDUCT.md 🎉 Initial Commit Sep 11, 2019
LICENSE 📝 Update LICENSE Sep 13, 2019
README.md 📝 Update README Dec 17, 2019
babel.config.js 🐛 Fix babel configuration Oct 1, 2019
degit.json 🔧 Change remove paths to allow for workflows Jan 14, 2020
firebase.json 🆕 Add Localization! Dec 12, 2019
gulpfile.js 📦 Bump static-site-scaffold and eleventy Jan 14, 2020
lighthouse.config.json 💚 Add Lighthouse assertions and URLs Jan 14, 2020
package.json 💚 Add GitHub Action for build, test, and Lighthouse Jan 14, 2020
rollup.config.js 💥 Migrate to Static Site Scaffold 2.0 Dec 12, 2019
rollup.sw.js 💥 Migrate to Static Site Scaffold 2.0 Dec 12, 2019

README.md

Static Site Scaffold

The Static Site Scaffold is an opinionated configuration of Eleventy for HTML compiling and templating, Rollup for JavaScript compiling and optimization, and Gulp for Sass compiling and asset optimization, designed to allow you to build fast, optimized Progressive Web Apps using familiar technology. The scaffolding is set up to be CI-ready, including relevant linting and testing, including Lighthouse tests. Finally, it includes configuration to deploy to Firebase Hosting.

Usage

While you can use the configuration module on its own, the easiest way to get started is by pulling in the whole scaffolding:

npx degit chromeos/static-site-scaffold my-awesome-site

This will download the latest version of the scaffolding files and put them into a new folder my-awesome-site. You should then cd into that folder, git init it to enable version control, and run npm install, or equivalent. It requires at least Node v10 to run.

Internationalization and Localization

Static Site Scaffold has basic internationalization (i18n) in place by default, allowing sites to be fully localized (l10n). This means that, out-of-the-box, you're set up to build multi-lingual sites without additional configuration needed and, if you don't need it, it's straight forward to remove.

In order to create a localization, first create a folder named after the ISO 639-1 code for the language you want to include, and in that folder, create a JSON file of the same name that includes that ISO language code (code) and writing direction (dir) inside a locale object. For English, it would look like the following:

{
  "locale": {
    "code": "en",
    "dir": "ltr"
  }
}

This will add a locale global variable to each page inside that folder with the correct localization information, which you can then use as needed. This will also cascade into layouts, allowing this localization information to be used throughout your site.

From there, you have two options for making localized pages: translating individual pages or generating pages from data. The former is fairly straight-forward, it's like managing any other data you may have, or you can use a tool like GitLocalize to assist in managing translations for you. For the later, you would use Eleventy's pagination to generate pages based on input date. See src/_generated/index.html for an example that loops over all of the data in the l10n global data object (which contains all data from all locale JSON files) and generates a language-specific landing page for each language. In addition, the following filters have been included to make localization and internationalization easier:

  • date(locale = 'en', format = {}) - Localizes a given date. In the simplest usecase, you can use it as {{ published | date(locale.code)}}. Format is an object corrisponding to the options for toLocaleDateString()
  • localeURL(locale) - Transforms a passed in URL, like Eleventy's page.url global, into a localized version based on the folder structure localization pattern. Simple usage would be {{page.url | localeURL(locale.code)}}
  • langName - Return the ISO 639-1 language name, in the native language, for the given locale code. Simple usage would be {{locale.code | langName}}

Service Worker Includes

The service worker that comes with this scaffold includes the ability to do Service Worker Includes. Service Worker Includes (SWIs) are based on Server Side Includes and currently supports the include directive and the virtual parameter, and requires the include be part of the Service Worker precache. SWIs work by removing the static-rendered includes in served HTML before it enters the user's cache, and replacing the includes with their content when the HTML is served from cache. This allows content and certain components to be cached separately, allowing only a portion of a page's cached content to need to be invalidated when things like global components change.

In order to use SWIs, you need to wrap the include's rendered HTML in a start include comment, <!--#include virtual="/path/from/root/to/component.txt"-->, and and end include comment <!--#endinclude-->. This can be done consistently using Nunjucks macro definitions. The navigation component (reproduced below, found in templates/_components/nav.html) does this to allow navigation to be included:

{% macro nav(locale, ssi = true) %} {% if ssi %}<!--#include virtual="/_components/{{locale}}/nav.txt"-->{% endif %}
<nav>
  <ul>
    <li><a href="/{{locale}}">Home</a></li>
    <li><a href="/{{locale}}/typography">Typography</a></li>
  </ul>
</nav>
{% if ssi %}<!--#endinclude-->{% endif %} {% endmacro %}

Given that a copy of this needs to be available separately, you'll need to compile a version that will live at the URL specified in the start include comment. You can do this a number of ways by creating a one-off render in the views directory, or you can generate it like is done for the nav component (reproduced below, found in views/_generated/nav.html).

---
pagination:
  data: l10n
  size: 1
  alias: l10n
permalink: '_components/{{ l10n.locale.code | slug }}/nav.txt'
---

{% from 'nav.html' import nav %} {{ nav(l10n.locale.code, false) }}

Folder & Config

Most configuration can be done in the config file (config/default.yml), which uses the config module. In addition to this config, .eleventy.js, rollup.config.js, rollup.sw.js, babel.config.js, and gulpfile.js are configuration files for their various tools, and have their configuration pulled in from the static-site-scaffold module so that their configuration can be versioned and updated independently from this scaffolding. The Rollup config also exports the individual pieces that make up a valid configuration, so you can take the generated config and expand upon it.

├── config
│   ├── default.{yaml|js|json}
│   └── production.{yaml|js|json}
├── templates
│   ├── _components
│   │   └── **/*.{html|njk}
│   └── _layouts
│       └── **/*.{html|njk}
├── views
│   ├── _data
│   │   ├── l10n.js
│   │   ├── site.js
│   │   └── **/*.{js|json}
│   ├── en
│   │   ├── en.json
│   │   └── **/*.{html|md}
│   ├── fr
│   │   ├── fr.json
│   │   └── **/*.{html|md}
│   ├── _generated
│   │   └── **/*.{html|md}
│   ├── 404.html
│   ├── index.html
│   └── **/*.{html|md}
├── src
│   ├── fonts
│   │   └── **/*.{ttf|woff|woff2}
│   ├── images
│   │   └── **/*.{jpg|png|svg|webp}
│   ├── js
│   │   ├── main.js
│   │   └── **/*.js
│   ├── sass
│   │   ├── style.scss
│   │   └── **/*.scss
│   └── videos
│   │   └── **/*.{webm|mp4}
│   ├── manifest.json
│   └── sw.js
├── tests
│   ├── lighthouse.js
│   ├── log.js
│   └── helpers
│       └── **/*.js
├── package.json
├── package-lock.json
├── .eleventy.js
├── rollup.config.js
├── rollup.sw.js
├── babel.config.js
├── gulpfile.js
├── firebase.json
├── LICENSE
├── README.md
├── .editorconfig
├── .prettierrc
├── .eslintrc.yml
├── .sass-lint.yml
├── .firebaserc
└── .gitignore
You can’t perform that action at this time.