Version Packages

By default, the sidebar nav redirects clicks on category headings to
their first child.

To disable those redirects, override
`_includes/_joiningBlocks/_layoutSidebar/sidebar/20-navigation.njk`
and add the `no-redirects` attribute to the `<rocket-navigation>`
element.

CONTRIBUTING.md

@@ -4,27 +4,27 @@
 
 > Please note that this project is released with a [Contributor Code of Conduct](./CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
 
-First, create a fork of the [modernweb-dev/rocket](https://github.com/modernweb-dev/rocket) repo by hitting the `fork` button on the GitHub page.
+First, create a fork of the [modernweb-dev/rocket](https://github.com/modernweb-dev/rocket) repository by hitting the `fork` button on the GitHub page.
 
-Next, clone our repository onto your computer with this command (replacing YOUR_USERNAME with your actual GitHub username)
+Next, clone our repository onto your computer.
 
 ```sh
 git clone git@github.com:modernweb-dev/rocket.git
 ```
 
-Once cloning is complete, change directory to the repo.
+Once cloning is complete, change directory to the repository.
 
 ```sh
 cd rocket
 ```
 
-Now add your fork as a remote
+Now add your fork as a remote (replacing YOUR_USERNAME with your GitHub username).
 
 ```sh
-git remote add fork git@github.com:<YOUR_NAME>/rocket.git
+git remote add fork git@github.com:<YOUR_USERNAME>/rocket.git
 ```
 
-Create a new local branch
+Create a new local branch.
 
 ```sh
 git checkout -b my-awesome-fix
@@ -32,7 +32,7 @@ git checkout -b my-awesome-fix
 
 ## Preparing Your Local Environment for Development
 
-Now that you have cloned the repository, ensure you have [yarn](https://classic.yarnpkg.com/lang/en/) installed run the following commands to set up the development environment.
+Now that you have cloned the repository, ensure you have [yarn](https://classic.yarnpkg.com/lang/en/) installed, then run the following commands to set up the development environment.
 
 ```sh
 yarn install
@@ -42,25 +42,25 @@ This will download and install all packages needed.
 
 ## Making Your Changes
 
-Make your changes to the project. Commits are linted using precommit hooks, meaning that any code that raises linting error cannot be committed. In order to help avoid that, we recommend using an IDE or editor with an eslint plugin in order to streamline the development process. Plugins are available for all the popular editors. For more information see [ESLint Integrations](https://eslint.org/docs/user-guide/integrations)
+Make your changes to the project. Commits are linted using precommit hooks, meaning that any code that raises a linting error cannot be committed. In order to help avoid that, we recommend using an IDE or editor with an ESLint plugin in order to streamline the development process. Plugins are available for all the popular editors. For more information see [ESLint Integrations](https://eslint.org/docs/user-guide/integrations)
 
-### Compiling the typescript code
+### Compiling the TypeScript Code
 
-If you're making cross-package changes, you need to compile the typescript code. We recommend executing `tsc:watch` from the root of the package and keeping that running while you make your changes.
+If you're making cross-package changes, you need to compile the TypeScript code. We recommend executing `tsc:watch` from the root of the package and keeping that running while you make your changes.
 
-### Running tests
+### Running Tests
 
 To run the tests of a package, it's recommended to `cd` into the package directory and then using `yarn test` to run them. This way you're only running tests of that specific package.
 
-### Integration testing
+### Integration Testing
 
 To see how your changes integrate with everything together you can use the `test-runner` package. There are different commands in this package which you can execute to trigger different scenarios in the test runner.
 
-## Adding new packages
+## Adding New Packages
 
 For all projects the tsconfig/jsconfig configuration files are auto generated. You need to add an entry to the [./workspace-packages.ts](./workspace-packages.ts) to let it generate a config for you. After adding an entry, run `yarn update-package-configs` to generate the files for you.
 
-## Create a Changeset
+## Creating a Changeset
 
 If you made changes for which you want to trigger a release, you need to create a changeset.
 This documents your intent to release, and allows you to specify a message that will be put into the changelog(s) of the package(s).

README.md

@@ -1,4 +1,4 @@
-> This project is in it's BETA phase
+> This project is in its BETA phase
 
 <p align="center">
   <img
@@ -33,7 +33,7 @@
 
 **The modern web setup for static sites with a sprinkle of JavaScript!**
 
-- **Meta Framework:** Build on top of giants like <a href="https://www.11ty.dev/">eleventy</a>, <a href="https://rollupjs.org/">Rollup</a>, and <a href="https://www.modern-web.dev/">Modern Web</a>.
+- **Meta Framework:** Build on top of giants like <a href="https://www.11ty.dev/">Eleventy</a>, <a href="https://rollupjs.org/">Rollup</a>, and <a href="https://www.modern-web.dev/">Modern Web</a>.
 - **Powerful Default Template:** Provide content and you are ready to go.
 - **Small:** No overblown tools or frontend frameworks, add JavaScript and/or Web Components only on pages where needed..
 
@@ -41,12 +41,12 @@
   <a href="https://rocket.modern-web.dev/guides/"><strong>Explore the Rocket Guides&nbsp;&nbsp;▶</strong></a>
 </p>
 
-## The goal for Rocket
+## The Goal for Rocket
 
-> Our goal is to provide developers with a meta framework for static websites with a spricle of JavaScript.
+> Our goal is to provide developers with a meta framework for static websites with a sprinkle of JavaScript.
 
 Get a site up and running in no time and focus on the content.
-You can still tweak every details of every underlying tool that get's used.
+You can still tweak every detail of every underlying tool that gets used.
 
 Rocket is part of the [Modern Web Family](https://twitter.com/modern_web_dev).
 
@@ -54,7 +54,7 @@ Rocket is part of the [Modern Web Family](https://twitter.com/modern_web_dev).
 
 We are always looking for contributors of all skill levels! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/modernweb-dev/rocket/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
 
-If you are interested in helping contribute to Modern Web, please take a look at our [Contributing Guide](https://github.com/modernweb-dev/rocket/blob/main/CONTRIBUTING.md). Also, feel free to drop into [slack](https://rocket.modern-web.dev/discover/slack/) and say hi. 👋
+If you are interested in helping contribute to Modern Web, please take a look at our [Contributing Guide](https://github.com/modernweb-dev/rocket/blob/main/CONTRIBUTING.md). Also, feel free to drop into [slack](https://rocket.modern-web.dev/about/slack/) and say hi. 👋
 
 ### Financial Contributors
 

docs/404.md

@@ -1,4 +1,4 @@
 ---
-layout: 404.njk
+layout: layout-404
 permalink: 404.html
 ---

docs/_assets/body.css

@@ -0,0 +1,10 @@
+html {
+  --demo-background-color: #eee;
+  --demo-color: #222;
+}
+
+html[theme="dark"] body {
+  background: #333;
+  --demo-background-color: #888;
+  --demo-color: #eee;
+}

docs/_assets/style.css

@@ -1,11 +1,11 @@
-body[layout='home'] .markdown-body .call-to-action:nth-of-type(2) {
+body[layout^='layout-home'] .markdown-body .call-to-action:nth-of-type(2) {
   --primary-color: #222;
   --primary-color-lighter: #333;
   --primary-color-darker: #000;
 }
 
 @media screen and (min-width: 1024px) {
-  body[layout='home'][home-layout='background'] .page-background {
+  body[layout='layout-home-background'] .page-background {
     top: -210px;
     right: -463px;
     transform: rotate(45deg);

docs/_data/footer.json

@@ -16,7 +16,7 @@
     "name": "Follow",
     "children": [
       {
-        "text": "Github",
+        "text": "GitHub",
         "href": "https://github.com/modernweb-dev/rocket"
       },
       {

docs/_data/site.cjs

@@ -3,7 +3,7 @@ module.exports = async function () {
     dir: 'ltr',
     lang: 'en',
     name: 'Rocket',
-    description: 'Rocket is the way to build fast static websites with a sprinkle of javascript',
+    description: 'Rocket is the way to build fast static websites with a sprinkle of JavaScript',
     socialLinks: [
       {
         name: 'GitHub',

docs/_includes/_joiningBlocks/head/site.njk

@@ -7,3 +7,5 @@
   rel="stylesheet"
 />
 <meta name="twitter:creator" content="@modern_web_dev" />
+
+<link rel="stylesheet" href="{{ '/_assets/body.css' | asset | url }}" mdjs-use>

docs/about/slack.md

@@ -1,5 +1,5 @@
 # Slack
 
-You can also find us on the Polymer slack in the [#open-wc](https://slack.com/share/IUQNUPWUF/awabyN8iYH4dXX6aGpu16ES9/enQtOTc2Nzc2ODEyOTY3LWM5ZGExNGFiMmM4NDY2YWI2MzYwOGY5ZTNlZjk4OGU4NTFhMGJjNmVhNGI4MzVlNTMwNGRiNGIxNjc4MGJhNDg) channel.
+You can also find us on the Polymer Slack in the [#open-wc](https://polymer.slack.com/archives/CE6D9DN05) channel.
 
-You can join the Polymer slack by visiting https://www.polymer-project.org/slack-invite.
+You can join the Polymer Slack by visiting [https://www.polymer-project.org/slack-invite](https://www.polymer-project.org/slack-invite).

docs/about/sponsor.md

@@ -6,4 +6,4 @@ eleventyNavigation:
 
 We currently can only accept sponsoring in the form of services or contributions.
 
-If you are interested in monetary sponsoring please [let as know as](mailto:hello@modern-web.dev).
+If you are interested in monetary sponsoring please [let us know](mailto:hello@modern-web.dev).

docs/blog/index.md

@@ -1,6 +1,5 @@
 ---
-title: Rocket Blog
-layout: blog
+layout: layout-blog-overview
 eleventyNavigation:
   key: Blog
   order: 30
@@ -11,4 +10,6 @@ pagination:
   alias: posts
 ---
 
+# Rocket Blog
+
 Discover articles from the core team and contributors about Rocket, tips and tricks included!

docs/blog/introducing-check-html-links.11tydata.cjs

@@ -0,0 +1,12 @@
+const { createSocialImage } = require('@rocket/cli');
+
+module.exports = async function () {
+  const socialMediaImage = await createSocialImage({
+    title: 'Introducing',
+    subTitle: 'check-html-links',
+    footer: 'Rocket Blog',
+  });
+  return {
+    socialMediaImage,
+  };
+};

docs/blog/introducing-check-html-links.md

@@ -0,0 +1,206 @@
+---
+title: Introducing Check HTMl Links - no more bad links
+published: true
+description: A fast link checker for static HTML
+tags: [html, javascript, webdev, node]
+cover_image: https://dev-to-uploads.s3.amazonaws.com/i/an9z6f4hdll2jlne43u3.jpg
+---
+
+**TL;DR : I created a standalone tool that can help you fix all the broken links in your websites/documentation. You can check it out [on npm as check-html-links](https://www.npmjs.com/package/check-html-links)**
+
+In my developer career, I have put live multiple websites and honestly often within a few days, there was always this one issue raised. "This link on xxx is broken". 🤦‍♂️
+
+Often these things happen as somewhere a page got moved or renamed and not every location got updated.
+It's really hard to catch especially if you have a dynamic page like with WordPress or an SPA. And for users, there is nothing worse than landing on your documentation only to find a 404 staring back at them.
+
+Luckily, with the rise of SSG (Static Site Generators), this problem becomes easier to tackle and can be solved in large part. The reason for that is that with all HTML rendered upfront as static files we can read all of them and check every link.
+
+## Evaluation and the Decision for a New Tool
+
+Of course, I am not the first one to come up with that idea and there are multiple tools available on the market already.
+However, when checking existing solutions I found out that most of them didn't satisfy me in at least one way 😅. Things I noticed: slow to execute, deprecated, large dependency tree, confusing output for the user, ...
+
+Reviewing these tools I decided to create my own, with the following requirements :
+
+- Blazing fast
+- User-focused output
+- Few dependencies, to keep it lean
+- Preferably in the Node.js ecosystem
+
+## Focusing on Useful Output
+
+Most tools evaluated check files individually and report on their findings individually. That means if you have a broken link in your header or footer, you will get one line (or even multiple lines) of an error message(s) for EVERY page.
+
+I tested this on the [11ty-website](https://github.com/11ty/11ty-website) and there are currently 516 broken links in 501 files. However, **the source of those 516 broken links is just 13 missing pages/resources**.
+
+In my implementation, I decided to switch from an "Error in File Focused" method to a "Missing File Focused". Let's see this with examples
+
+### Error in File Focused
+
+This is what a lot of current existing solutions implement. Here is part of the output that is being produced:
+
+```
+[...]
+authors/ryzokuken/index.html
+  target does not exist --- authors/ryzokuken/index.html --> /speedlify/
+authors/alex_kaul/index.html
+  target does not exist --- authors/alex_kaul/index.html --> /speedlify/
+docs/config/index.html
+  target does not exist --- docs/config/index.html --> /speedlify/
+  hash does not exist --- docs/config/index.html --> /docs/copy/#disabling-passthrough-file-copy
+authors/cramforce/index.html
+  target does not exist --- authors/cramforce/index.html --> /speedlify/
+authors/accudio/index.html
+  target does not exist --- authors/accudio/index.html --> /speedlify/
+[...]
+```
+
+We get ~2000 lines of errors for `/speedlify/` as it's not found ~500 times. In the middle of those errors, we also see some other broken links.
+Because the reporting is focusing first on the files, and then on the actual error **it is difficult to know where most errors originate from**.
+
+### Missing File Focused
+
+Let us turn that around and focus on missing references indeed. Here is the output for the same input website :
+
+```
+[...]
+  1. missing reference target _site/speedlify/index.html
+    from _site/404.html:1942:13 via href="/speedlify/"
+    from _site/authors/_amorgunov/index.html:2031:13 via href="/speedlify/"
+    from _site/authors/_coolcut/index.html:2031:13 via href="/speedlify/"
+    ... 495 more references to this target
+
+  2. missing id="disabling-passthrough-file-copy" in _site/docs/copy/index.html
+    from _site/docs/config/index.html:2527:267 via href="/docs/copy/#disabling-passthrough-file-copy"
+
+  3. missing reference target _site/authors/dkruythoff/github.com/dkruythoff/darius-codes
+    from _site/authors/dkruythoff/index.html:2102:234 via href="github.com/dkruythoff/darius-codes"
+[...]
+```
+
+We get one 5 line error for `/speedlify/` and it tells us it's missing 495 times + 3 examples usages.
+Afterward, we find very clearly more missing references and where they occurred.
+
+### A Clear Winner
+
+Comparing those two outputs makes it pretty clear to me that `Missing File Focused` will make more sense if there is a chance that some links will be broken everywhere. My implementation focuses on missing links in its output. This is crucial because it allows developers to know where to focus their efforts first to get the biggest wins.
+
+## Focusing on Speed
+
+Speed is always nice to have but in this case, it's probably vital. I need this to be fast so that I can run it potentially on every save. Speed is also very important in case the tool runs in a CI for example. For projects with extensive documentation, we don't want to hog the CI only to check for documentation.
+
+Luckily HTML is an awesome language to analyze as it's declarative, which means you can read and analyze it at the same time. This may even mean that the HTML is already processed by the time the file is done reading.
+
+With this knowledge I was hopeful - but reality didn't deliver 😅. The only tool that could keep up with the speed I needed was implemented in [Go](https://golang.org/).
+
+It seems that most tools use sophisticated parsers meant to create full syntax trees of your HTML.
+In reality for link checking all you need to know are the _id_ and the _href_ attributes.
+
+I have been using [sax-wasm](https://github.com/justinwilaby/sax-wasm) in a few situations before and I knew it supported streaming. I knew that way it could be FAST 🤞!
+
+How fast are we talking about though?
+
+As a rule of thumb, I decided that the analysis should be finished within 1s for a small site (up to 200 pages).
+The main reason is already listed above: To not disturb during writing/development as it will run on every save.
+For medium sites (200 - 1000 pages), it's reasonable if it takes a little longer - let's aim for less than 5 seconds. This will probably be a breaking point where you execute it only on-demand and in the CI instead of executing it on every save.
+
+Results are gatherd on January 26, 2021:
+
+| Website     | Pages | Duration |
+| ----------- | ----- | -------- |
+| open-wc.org | 90    | ~0.4s    |
+| 11ty.dev    | 501   | ~2.5s    |
+| web.dev     | 830   | ~3.7s    |
+| eslint.org  | 3475  | ~12.4s   |
+
+## Being Part of the Node.js Ecosystem
+
+My daily workflow is hugely dominated by JavaScript, so it was only natural to want to stay in the same environment if I could reach my earlier requirements with it.
+On top of this, the end goal is to integrate it within a bigger WIP system called [Rocket](https://github.com/modernweb-dev/rocket) which is node-based so therefore it will need to at least support Node.js. Having it standalone (usable via `npx`) also makes it more versatile and easier to maintain/test.
+
+## Focusing on a Small Dependency Tree
+
+The JavaScript and Node.js ecosystem is very active and constantly shifting. Lots of changes/improvements happen all the time. It's often hard to keep up. Therefore having a small dependency tree is something to always thrive for because it will reduce the maintenance burden down the line. And as an added benefit, it makes it smaller and easily embeddable as less stuff has to go down the wire. Lean is king 👑.
+
+## Solution
+
+As already mentioned I went on and implement a link checker myself 😅. So far it fits all my requirements so I call it a success 🎉! You can find it [on npm](https://www.npmjs.com/package/check-html-links).
+
+I called it `check-html-links` and its slogan is "no more broken links or assets".
+
+The features so far are:
+
+- extracts every attribute value of id, href, src, srcset
+- use a Wasm parser (sax-wasm)
+- streams the HTML for performance
+- check if file or id within file exist
+- focus on missing references/sources
+
+## Usage
+
+It checks your final HTML output so you need to execute it after your Static Site Generator.
+
+```
+npx check-html-links _site
+```
+
+## GitHub Action Usage
+
+[Julien](https://twitter.com/jlengrand) created a GitHub action available for the tool, so you can easily plug it in your existing CI. You can find it [on the GitHub Marketplace](https://github.com/marketplace/actions/check-html-links-action).
+
+Here is a complete example workflow that will check the result of the folder `_site` in the root of your repository on each push:
+
+```yml
+on: [push]
+
+jobs:
+  check_html_links_job:
+    runs-on: ubuntu-latest
+    name: A job to test check-html-links-action
+    steps:
+      - uses: actions/checkout@v2
+      - name: check-html-links-action step
+        id: check-links
+        uses: modernweb-dev/check-html-links-action@v1
+        with:
+          doc-folder: '_site_'
+```
+
+## Comparison
+
+Checking the output of the [11ty-website](https://github.com/11ty/11ty-website) with 13 missing reference targets (used by 516 links) while checking 501 files. (on January 17, 2021)
+
+| Tool             | Lines printed | Duration | Lang | Dependency Tree |
+| ---------------- | ------------- | -------- | ---- | --------------- |
+| check-html-links | 38            | ~2.5s    | node | 19              |
+| link-checker     | 3000+         | ~11s     | node | 106             |
+| hyperlink        | 68            | 4m 20s   | node | 481             |
+| htmltest         | 1000+         | ~0.7s    | GO   | -               |
+
+## Future
+
+The basic functionality is finished and it's reasonabley fast.
+
+Topic to work on:
+
+- Allow to ignore folders (potentially via a cli parameter)
+- Support for `<base href="/">`
+- Big Sites Speed improvements (potentially running multiple parsers in parallel for 1000+ pages)
+- Speed improvements by introducing a "permanent cache" for the parse result (if file did not change, parse result will not change - we still check all links)
+- Memory consumption check (see if there is room for improvements)
+- Improve node api
+- Check external links
+
+## Acknowledgements
+
+Thank you for following along on my journey on creating `check-html-links`. You can find the code on [GitHub](https://github.com/modernweb-dev/rocket/tree/main/packages/check-html-links).
+
+Follow us on [Twitter](https://twitter.com/modern_web_dev), or follow me on my personal [Twitter](https://twitter.com/dakmor).
+
+Thanks to [Julien](https://twitter.com/jlengrand) for feedback and helping turn my scribbles to a followable story.
+
+If you think my open source work is valuable then I would like you to check out my personal [GitHub Sponsor Page](https://github.com/sponsors/daKmoR). Or you can support our whole group via the [Modern Web Open Collective](https://opencollective.com/modern-web).
+
+---
+
+<span>Photo by <a href="https://unsplash.com/@mihaiteslariu0?utm_source=unsplash&amp;utm_medium=referral&amp;utm_content=creditCopyText">Teslariu Mihai</a> on <a href="https://unsplash.com/?utm_source=unsplash&amp;utm_medium=referral&amp;utm_content=creditCopyText">Unsplash</a></span>

docs/blog/introducing-rocket/index.md

@@ -1,16 +0,0 @@
----
-title: Introducing rocket - effective static content with some javascript
-published: true
-description: Write Interactive Demos Using Markdown and JavaScript
-tags: [markdown, javascript, webcomponents, demos]
-cover_image: /blog/introducing-rocket/images/blog-header.jpg
-socialMediaImage: /blog/introducing-rocket/images/social-media-image.jpg
----
-
-Welcome to the next level of content creation.
-
-## Here comes the navigation
-
-Stuff
-
-## Another anchor

docs/docs/configuration/computed-config.md

@@ -0,0 +1,42 @@
+# Configuration >> Computed Config ||20
+
+If you want to add data that depends on other data then you can do it via [Eleventy's computed data](https://www.11ty.dev/docs/data-computed/).
+
+Rocket exposes it via `setupEleventyComputedConfig`.
+
+## Set Your Own Data
+
+Let's say you want to add a `Welcome to the contact page` everywhere. (A filter might be a better choice, but it's a good example of the concept.)
+
+👉 `rocket.config.mjs` (or your theme config file)
+
+```js
+import { addPlugin } from 'plugins-manager';
+
+/** @type {Partial<import("../../../types/main").RocketCliOptions>} */
+const config = {
+  setupEleventyComputedConfig: [
+    addPlugin({ name: 'greeting', plugin: data => `Welcome to the ${data.title} page.` }),
+  ],
+};
+
+export default config;
+```
+
+{% raw %}
+Now you can use {{ greeting }} everywhere.
+{% endraw %}
+And it will be correctly replaced with a Welcome and the page title.
+
+## Default Available Configs
+
+```js
+[
+  { name: 'titleMeta', plugin: titleMetaPlugin },
+  { name: 'title', plugin: titlePlugin },
+  { name: 'eleventyNavigation', plugin: eleventyNavigationPlugin },
+  { name: 'section', plugin: sectionPlugin },
+  { name: 'socialMediaImage', plugin: socialMediaImagePlugin },
+  { name: 'templateBlocks', plugin: templateBlocksPlugin, options: rocketConfig },
+];
+```

docs/docs/configuration/images.md

@@ -0,0 +1,223 @@
+# Configuration >> Images ||40
+
+Rocket does handle content images automatically by
+
+- producing multiple sizes so users download images that are meant for their resolution
+- outputting multiple formats so the device can choose the best image format it supports
+
+And the best thing about is you don't need to do anything.
+
+## Usage
+
+If you are using markdown images you are good to go.
+
+```md
+![My Image](path/to/image.jpg)
+```
+
+will result in
+
+```html
+<picture>
+  <source
+    type="image/avif"
+    srcset="/images/5f03d82-300.avif 300w, /images/5f03d82-820.avif 820w"
+    sizes="(min-width: 1024px) 820px, calc(100vw - 20px)"
+  />
+  <source
+    type="image/jpeg"
+    srcset="/images/5f03d82-300.jpeg 300w, /images/5f03d82-820.jpeg 820w"
+    sizes="(min-width: 1024px) 820px, calc(100vw - 20px)"
+  />
+  <img
+    alt="My Image"
+    rocket-image="responsive"
+    src="/images/5f03d82-300.jpeg"
+    width="300"
+    height="158"
+    loading="lazy"
+    decoding="async"
+  />
+</picture>
+```
+
+## Benefits
+
+The main benefit is that we can serve the correct size and optimal image format depending on the browser capabilities leading to optimal loading times on different systems.
+
+- Smaller images for smaller screens
+
+  When providing `srcset` and `sizes` the browser can decide which image makes the most sense to download.
+  This will lead to much faster websites especially on mobile where smaller images can be served.
+  If you wanna know more check out [The anatomy of responsive images](https://jakearchibald.com/2015/anatomy-of-responsive-images/).
+
+- Serve the best/smallest image format the browser understands
+
+  There are currently ~3 formats you may want to consider `avif`, `webp` and `jpg`. The improvements are huge [webp is ~30% and avif ~50%](https://www.ctrl.blog/entry/webp-avif-comparison.html) smaller then the original jpg.
+
+## Adding a caption
+
+If you want to describe your image in more detail you can add a caption
+
+```md
+![My Image](path/to/image.jpg 'My caption text')
+```
+
+will result in
+
+```html
+<figure>
+  <picture>
+    <!-- picture code the same as above -->
+  </picture>
+  <figcaption>My caption text</figcaption>
+</figure>
+```
+
+## Adjusting options
+
+Under the hood it is using [11ty/image](https://www.11ty.dev/docs/plugins/image/) and all it's options are available.
+
+<inline-notification type="tip">
+
+If you are using a layout preset like `@rocket/launch` then you probably don't want to touch/change these options as the preset will set it for you accordion to its layout needs.
+
+The default preset for regular markdown content is available as `responsive`.
+
+</inline-notification>
+
+👉 `rocket.config.js`
+
+```js
+export default {
+  imagePresets: {
+    responsive: {
+      widths: [300, 820],
+      formats: ['avif', 'jpeg'],
+      sizes: '(min-width: 1024px) 820px, calc(100vw - 20px)',
+    },
+  },
+};
+```
+
+## Defining your own presets
+
+You can add your own image preset like so
+
+```js
+export default {
+  imagePresets: {
+    'my-image-preset': {
+      widths: [30, 60],
+      formats: ['avif', 'jpeg'],
+      sizes: '(min-width: 1024px) 30px, 60px',
+    },
+  },
+};
+```
+
+Once that `imagePreset` is defined you can use it by adding it to any `img` tag.
+
+```html
+<img src="./path/to/image.jpg" alt="my alt" rocket-image="my-image-preset" />
+```
+
+## How does it work?
+
+1. Each markdown image `![my image](path/to/image.jpg)` gets rendered as `<img src="path/to/image.jpg" alt="my image" rocket-image="responsive">`
+2. We parse the html output and process every image which has `rocket-image`
+3. Get the image preset settings from the name e.g. `rocket-image="my-image-preset"` reads `imagePreset['my-image-preset']`
+4. Pass the settings onto `@11ty/image` to generate the image sizes and formats
+5. With the metadata we render the html
+
+## Default Formats
+
+An [image file format](https://en.wikipedia.org/wiki/Image_file_formats) is a way of storing common image formats. Each format varies in capabilities like compression algorithm, availability, progressive rendering, encode and decode time, ...
+Ultimately newer formats are usually smaller while retaining image quality which leads to faster websites.
+
+By default, we generate `avif` and `jpg` because
+
+- we only want to generate two versions to limit CI time and html size
+- `avif` is significantly smaller than `webp`
+- `avif` is available in
+  - Chrome since August 2020
+  - Firefox since June 2021
+- `jpg` as a fallback for Edge, Safari, IE11
+- `webp` would only help a small percentage of Edge & Safari on macOS 11 (Big Sur) users
+
+This leads to the following situation:
+
+- Chrome, Firefox gets the small `avif`
+- Edge, Safari, IE11 gets the bigger `jpg`
+
+To learn more about `avif` take a look at [AVIF has landed](https://jakearchibald.com/2020/avif-has-landed/).
+
+If you want to add `webp` (or replace `avif` with it) you can do so by setting the formats
+
+👉 `rocket.config.js`
+
+```js
+export default {
+  imagePresets: {
+    responsive: {
+      formats: ['avif', 'webp', 'jpeg'],
+    },
+  },
+};
+```
+
+## Default widths
+
+In order to understand the need for having a single image in multiple resolutions we need to understand the our website is served to many different environments and each may come with its own specific device pixel ratio (DPR). The device pixel ratio is the ratio between physical pixels and logical pixels. For instance, the Galaxy S20 report a device pixel ratio of 3, because the physical linear resolution is triple the logical linear resolution.
+
+Physical resolution: 1440 x 3200
+Logical resolution: 480 x 1067
+
+And 1440 / 480 = 3.
+
+By default, we generate the following widths `600`, `900` and `1640` because
+
+- we only want to generate a small amount of widths to limit CI time and service worker cache size
+- `600` is good for mobile with DRP 2
+- `900` is good for mobile with DRP 3 and desktop with DPR of 1
+- `1640` is good for desktop with DPR of 2
+
+If you want to add more widths you can add them to `widths`.
+
+👉 `rocket.config.js`
+
+```js
+export default {
+  imagePresets: {
+    responsive: {
+      widths: [300, 600, 900, 1200, 1640],
+      sizes: '(min-width: 1024px) 820px, calc(100vw - 20px)',
+    },
+  },
+};
+```
+
+<inline-notification type="tip">
+
+As an end user in most cases you don't want to mess with this as a layout preset should set this for you. If you are building your own layout preset then be sure to set `widths` and `sizes` via `adjustImagePresets`
+
+```js
+export function myPreset() {
+  return {
+    adjustImagePresets: imagePresets => ({
+      ...imagePresets,
+      responsive: {
+        ...imagePresets.responsive,
+        widths: [600, 900, 1640],
+        sizes: '(min-width: 1024px) 820px, calc(100vw - 40px)',
+      },
+    }),
+  };
+}
+```
+
+</inline-notification>
+
+```js script
+import '@rocket/launch/inline-notification/inline-notification.js';
+```

docs/docs/configuration/overview.md

@@ -2,7 +2,7 @@
 
 The configuration file is `rocket.config.js` or `rocket.config.mjs`.
 
-The config files consists of the following parts:
+The config files consist of the following parts:
 
 ```js
 import { rocketLaunch } from '@rocket/launch';
@@ -14,27 +14,30 @@ export default {
 };
 ```
 
-Rocket is primarily build around plugins for each of it's systems.
+Rocket is primarily build around plugins for each of its systems.
 
 New plugins can be added and all default plugins can be adjusted or even removed by using the following functions.
 
 ```js
 export default {
-  // add remark/unified plugin to the markdown processing (e.g. enable special code blocks)
+  // add remark/unified plugin to the Markdown processing (e.g. enable special code blocks)
   setupUnifiedPlugins: [],
 
   // add a rollup plugins to the web dev server (will be wrapped with @web/dev-server-rollup) AND the rollup build (e.g. enable json importing)
   setupDevAndBuildPlugins: [],
 
-  // add a plugin to the web dev server (will not be wrapped) (e.g. esbuild for typescript)
+  // add a plugin to the web dev server (will not be wrapped) (e.g. esbuild for TypeScript)
   setupDevPlugins: [],
 
   // add a plugin to the rollup build (e.g. optimization steps)
   setupBuildPlugins: [],
 
-  // add a plugin to eleventy (e.g. a filter packs)
+  // add a plugin to Eleventy (e.g. a filter packs)
   setupEleventyPlugins: [],
 
+  // add a computedConfig to Eleventy (e.g. site wide default variables like socialMediaImage)
+  setupEleventyComputedConfig: [],
+
   // add a plugin to the cli (e.g. a new command like "rocket my-command")
   setupCliPlugins: [],
 };
@@ -48,9 +51,9 @@ For some projects you might want to enable non-standard behaviors like importing
 import data from './data.json';
 ```
 
-You can accomplish this with rollup and dev server plugins. Make sure to add both the dev-server plugin as well as the rollup plugin, so that the behaviors is the same during development as it is in the production build.
+You can accomplish this with Rollup and dev server plugins. Make sure to add both the dev-server plugin as well as the Rollup plugin, so that the behaviors is the same during development as it is in the production build.
 
-For these cases you can use `setupDevAndBuildPlugins`, which will automatically add the plugin for you to both rollup and dev-server:
+For these cases you can use `setupDevAndBuildPlugins`, which will automatically add the plugin for you to both Rollup and dev-server:
 
 ```js
 import json from '@rollup/plugin-json';
@@ -66,8 +69,8 @@ const config = {
 export default config;
 ```
 
-This will add the rollup plugin `json` with the id `json` at the top of the plugin list of rollup and the dev server. It needs to be at the top so further plugins down the line can work with json imports.
-For the Dev Server the plugins are automatically wrapped by `@web/dev-server-rollup`. Note that [not all rollup plugins](https://modern-web.dev/docs/dev-server/plugins/rollup/#compatibility-with-rollup-plugins) will work with the dev-server.
+This will add the Rollup plugin `json` with the id `json` at the top of the plugin list of Rollup and the dev server. It needs to be at the top so further plugins down the line can work with JSON imports.
+For the Dev Server the plugins are automatically wrapped by `@web/dev-server-rollup`. Note that [not all Rollup plugins](https://modern-web.dev/docs/dev-server/plugins/rollup/#compatibility-with-rollup-plugins) will work with the dev-server.
 
 ## Modifying Options of Plugins
 

docs/docs/configuration/service-worker.md

@@ -0,0 +1,45 @@
+# Configuration >> Service Worker ||30
+
+Rocket does come with a default service worker that will
+
+- cache already visited pages
+- cache assets of visited pages (up to 100 files then it replaces older entries)
+- reload the page if a newer html page version is available on service worker activation
+
+## Adjusting the file name
+
+Changing the service worker file name can be quite a hassle so you can adjust generate file name via a config.
+
+👉 `rocket.config.js`
+
+```js
+export default {
+  serviceWorkerName: 'my-service-worker-name.js',
+};
+```
+
+## Meet the Service Worker
+
+The default service worker will work for many scenarios however your needs my vary.
+To enable different service worker strategies you can replace the default service worker code by providing a file at `_assets/service-worker.js`.
+This file will be auto transformed and generated in the root of the website using the defined `serviceWorkerName`.
+
+For inspiration, you can take a look at the default config.
+
+[https://github.com/modernweb-dev/rocket/blob/main/packages/cli/preset/\_assets/service-worker.js](https://github.com/modernweb-dev/rocket/blob/main/packages/cli/preset/_assets/service-worker.js)
+
+Be sure to check out [workbox](https://developers.google.com/web/tools/workbox) for more service worker magic.
+
+And if you wanna have a 30 minutes crash course we highly recommend the talk [Service Workers For The Rest Of Us](https://vimeo.com/362260166) by [Philip Walton](https://twitter.com/philwalton).
+
+## Registration
+
+The registration happens via another file that you can also overwrite at `_assets/scripts/registerServiceWorker.js`.
+
+Below you find the default implementation.
+
+<!-- prettier-ignore-start -->
+```js
+{{ '/_assets/scripts/registerServiceWorker.js' | asset | toAbsPath | inlineFilePath; }}
+```
+<!-- prettier-ignore-end -->

docs/docs/eleventy-plugins/mdjs-unified.md

@@ -1,6 +1,6 @@
-# Eleventy Plugins >> Markdown JavaScript (Mdjs)
+# Eleventy Plugins >> Markdown JavaScript (mdjs)
 
-Use mdjs in your 11ty site.
+Use mdjs in your Eleventy site.
 
 ## Setup
 
@@ -8,7 +8,7 @@ Use mdjs in your 11ty site.
 npm install @rocket/eleventy-plugin-mdjs
 ```
 
-Create an 11ty config file `.eleventy.js`
+Create an Eleventy config file `.eleventy.js`
 
 ```js
 const pluginMdjs = require('@rocket/eleventy-plugin-mdjs');
@@ -18,7 +18,7 @@ module.exports = function (eleventyConfig) {
 };
 ```
 
-## Configure a unified or remark plugin with mdjs
+## Configure a unified or remark Plugin with mdjs
 
 By providing a `setupUnifiedPlugins` function as an option to `eleventy-plugin-mdjs` you can set options for all unified/remark plugins.
 
@@ -43,12 +43,12 @@ module.exports = function (eleventyConfig) {
 };
 ```
 
-## Add a unified or remark plugin
+## Add a unified or remark Plugin
 
 The order of plugins is important in unified as each plugin processes the content and passes on its result.
-Some plugins do work with the markdown AST and some with the rehype (e.g. html) AST. In order to get access to the correct AST the plugin needs to be in a specific location in the processing order.
+Some plugins do work with the Markdown AST and some with the rehype (e.g. HTML) AST. In order to get access to the correct AST the plugin needs to be in a specific location in the processing order.
 
-Examples on how to insert a plugin right after creating the markdown AST.
+Examples on how to insert a plugin right after creating the Markdown AST.
 
 ```js
 const pluginMdjs = require('@rocket/eleventy-plugin-mdjs');

docs/docs/markdown-javascript/assets/demo-element.js

@@ -0,0 +1,69 @@
+class DemoElement extends HTMLElement {
+  constructor() {
+    super();
+    this.attachShadow({ mode: 'open' });
+
+    this.platform = 'the web';
+    this.language = 'en-US';
+    this.theme = 'light';
+
+    this.observer = new MutationObserver(this.updateData);
+  }
+
+  updateData = () => {
+    this.platform = document.documentElement.getAttribute('platform') || 'the web';
+    this.language = document.documentElement.getAttribute('data-lang') || 'en-US';
+    this.theme = document.documentElement.getAttribute('theme') || 'light';
+    this.requestUpdate();
+  };
+
+  connectedCallback() {
+    this.updateData();
+
+    this.observer.observe(document.documentElement, { attributes: true });
+  }
+
+  requestUpdate() {
+    this.shadowRoot.innerHTML = this.render();
+  }
+
+  render() {
+    return `
+      <style>
+        :host {
+          display: block;
+          background: var(--demo-background-color);
+          color: var(--demo-color);
+          padding: 10px;
+        }
+
+        :host[platform~="web"] {
+          border-bottom: 2px solid #333;
+        }
+
+        @media screen and (min-width: 640px) {
+          .about {
+            display: flex;
+          }
+          .about ul {
+            width: 50%;
+          }
+        }
+      </style>
+
+      <p>Hello I am DemoElement 👋</p>
+      <div class="about">
+        <ul>
+          <li>My purpose is to demonstrate how an element can adopt to different environments</li>
+          <li>I like <strong>${this.platform}</strong></li>
+        </ul>
+        <ul>
+          <li>My mother languages is <strong>${this.language}</strong></li>
+          <li>I feel very comfortable in the <strong>${this.theme}</strong></li>
+        </ul>
+      </div>
+    `;
+  }
+}
+
+customElements.define('demo-element', DemoElement);

docs/docs/markdown-javascript/overview.md

@@ -1,6 +1,12 @@
 # Markdown JavaScript >> Overview || 10
 
-Markdown JavaScript (Mdjs) is a format that allows you to use JavaScript with Markdown, to create interactive demos. It does so by "annotating" JavaScript that should be executed in Markdown.
+```js script
+import '@mdjs/mdjs-story/define';
+import '@mdjs/mdjs-preview/define';
+import { html } from '@mdjs/mdjs-story';
+```
+
+Markdown JavaScript (mdjs) is a format that allows you to use JavaScript with Markdown, to create interactive demos. It does so by "annotating" JavaScript that should be executed in Markdown.
 
 To annotate we use a code block with `js script`.
 
@@ -13,9 +19,9 @@ To annotate we use a code block with `js script`.
 ## Web Components
 
 One very good use case for that can be web components.
-HTML already works in markdown so all you need is to load a web components definition file.
+HTML already works in Markdown so all you need is to load a web components definition file.
 
-You could even do so within the same markdown file.
+You could even do so within the same Markdown file.
 
 ````md
 ## This is my-card
@@ -52,27 +58,18 @@ customElements.define('my-el', MyEl);
 
 ## Demo Support (Story)
 
-mdjs comes with some additional helpers you can choose to import via
+mdjs comes with some additional helpers you can choose to import:
 
 ````md
 ```js script
-import '@mdjs/mdjs-story/mdjs-story.js';
-import '@mdjs/mdjs-preview/mdjs-preview.js';
+import '@mdjs/mdjs-story/define';
+import '@mdjs/mdjs-preview/define';
 ```
 ````
 
-once loaded you can use them like so.
+Once loaded you can use them like so:
 
-````md
-```js script
-import '@mdjs/mdjs-story/mdjs-story.js';
-import '@mdjs/mdjs-preview/mdjs-preview.js';
-```
-````
-
-once loaded you can use them like so.
-
-### story
+### Story
 
 The code snippet will actually get executed at that place and you will have a live demo
 
@@ -88,7 +85,7 @@ export const JsStory = () => html` <demo-wc-card>JS Story</demo-wc-card> `;
 ```
 ````
 
-#### full code support
+#### Full Code Support
 
 ````md
 ```js story
@@ -101,7 +98,7 @@ export const JsStory = () => {
 ```
 ````
 
-### preview story
+### Preview Story
 
 Will become a live demo wrapped in a container with a show code button.
 
@@ -119,12 +116,6 @@ export const JsPreviewStory = () => html` <demo-wc-card>JS Preview Story</demo-w
 
 Here is a live example from [demo-wc-card](https://www.npmjs.com/package/demo-wc-card).
 
-```js script
-import '@mdjs/mdjs-story/mdjs-story.js';
-import '@mdjs/mdjs-preview/mdjs-preview.js';
-import { html } from 'lit-html';
-```
-
 ```js preview-story
 import 'demo-wc-card/demo-wc-card.js';
 export const header = () => {
@@ -134,40 +125,15 @@ export const header = () => {
 
 ## Supported Systems
 
-### es-dev-server
-
-Preview your mdjs readme with live demos and auto reload.
-
-- Add to your `package.json`:
-
-  ```json
-  "scripts": {
-    "start": "es-dev-server",
-  }
-  ```
-
-- Create a `es-dev-server.config.js` in the root of your repo.
-
-  ```js
-  const { mdjsTransformer } = require('@mdjs/core');
-
-  module.exports = {
-    nodeResolve: true,
-    open: 'README.md',
-    watch: true,
-    responseTransformers: [mdjsTransformer],
-  };
-  ```
-
 ### Storybook
 
 Please check out [@open-wc/demoing-storybook](https://open-wc.org/demoing/) for a fully integrated setup.
 
 It includes [storybook-addon-markdown-docs](https://open-wc.org/demoing/storybook-addon-markdown-docs.html) which uses mdjs under the hood.
 
-### Chrome Extension (currently only for Github)
+### Chrome Extension (currently only for GitHub)
 
-See live demos directly inside github page, markdown files, issues, pull requests...
+See live demos directly inside GitHub pages, Markdown files, issues, pull requests...
 
 Please check out [mdjs-viewer](https://github.com/open-wc/mdjs-viewer).
 
@@ -179,7 +145,7 @@ mdjs offers two more "basic" integrations
 
 #### `mdjsDocPage`
 
-Creates a full blown html page by passing in the markdown.
+Creates a full blown HTML page by passing in the Markdown.
 
 ```js
 const { mdjsDocPage } = require('@mdjs/core');
@@ -197,7 +163,7 @@ const page = await mdjsDocPage(markdownString);
 
 #### `mdjsProcess`
 
-Pass in multiple markdown documents and you get back all the jsCode and rendered html.
+Pass in multiple Markdown documents and you get back all the JavaScript code and rendered HTML.
 
 ```js
 const { mdjsProcess } = require('@mdjs/core');

docs/docs/markdown-javascript/preview.md

@@ -2,18 +2,165 @@
 
 You can showcase live running code by annotating a code block with `js preview-story`.
 
-````md
-```js preview-story
-import { html } from 'lit-html';
+## Features
 
-export const foo = () => html` <p>my html</p> `;
+- Shows components inside the page as they are
+- You can enable “Simulation Mode” to break them out
+- Simulation mode renders in an iframe to supporting media queries and isolated Simulation settings
+- Simulation Settings
+  - Style (windows, mac, android, iOS)
+  - Size (small, medium, large, Galaxy S5, iPhone X, iPad …)
+  - Automatic Height
+  - Theme (light, dark)
+  - Language (en, nl, …)
+- Settings are ”global” for all Simulators (e.g. changing one will change all)
+- Settings can be remembered for other pages / return visits
+
+```js script
+import { html } from '@mdjs/mdjs-preview';
+import './assets/demo-element.js';
+```
+
+## JavaScript Story
+
+````md
+```js script
+import { html } from '@mdjs/mdjs-preview';
+import './assets/demo-element.js';
+```
+
+```js preview-story
+export const foo = () => html`<demo-element></demo-element>`;
 ```
 ````
 
 will result in
 
 ```js preview-story
-import { html } from 'lit-html';
-
-export const foo = () => html` <p>my html</p> `;
+export const foo = () => html` <demo-element></demo-element> `;
+```
+
+## HTML Story
+
+````md
+```html preview-story
+<demo-element></demo-element>
+```
+````
+
+will result in
+
+```html preview-story
+<demo-element></demo-element>
+```
+
+## Setup Simulation Mode
+
+For simulation mode we need a dedicated html file that will be used as an iframe target while loading stories.
+
+The fastest way to create such a file is to use the `layout-simulator` layout.
+
+Create a file `docs/simulator.md` with the following content.
+
+```md
+---
+layout: layout-simulator
+eleventyExcludeFromCollections: true
+excludeFromSearch: true
+---
+```
+
+Once you have that you need to configure it for the story renderer by setting it in your `rocket.config.js`.
+
+```js
+export default {
+  setupUnifiedPlugins: [
+    adjustPluginOptions('mdjsSetupCode', {
+      simulationSettings: { simulatorUrl: '/simulator/' },
+    }),
+  ],
+};
+```
+
+<inline-notification type="tip">
+
+You can freely choose the path for the "simulator" by creating the md file in a different folder and adjusting the path in the config.
+
+</inline-notification>
+
+## Simulator states
+
+To simulate these stats that usually come from the device itself we put those infos on the document tag.
+
+We can simulate the following settings
+
+1. `platform`
+   Adopting styles and behavior depending on which device platform you are.
+   ```html
+   <html platform="web"></html>
+   <html platform="android"></html>
+   <html platform="ios"></html>
+   <!-- potentially later -->
+   <html platform="web-windows"></html>
+   <html platform="web-mac"></html>
+   ```
+2. `theme`
+   Adjust your styles based on a theme - light/dark are the default but you can add as many as you want.
+   ```html
+   <html theme="light"></html>
+   <html theme="dark"></html>
+   ```
+3. `language`
+   Best to relay on `data-lang` as `lang` often gets changes by translations services which may interfere with your translation loading system.
+   ```html
+   <html lang="en-US" data-lang="en-US"></html>
+   <html lang="de-DE" data-lang="de-DE"></html>
+   ```
+
+If you want to react to such document changes you can use an [MutationObserver](https://developer.mozilla.org/de/docs/Web/API/MutationObserver).
+
+For a vanilla web component it could look something like this:
+
+```js
+class DemoElement extends HTMLElement {
+  constructor() {
+    super();
+    this.attachShadow({ mode: 'open' });
+
+    this.platform = 'the web';
+    this.language = 'en-US';
+    this.theme = 'light';
+
+    this.observer = new MutationObserver(this.updateData);
+  }
+
+  updateData = () => {
+    this.platform = document.documentElement.getAttribute('platform') || 'the web';
+    this.language = document.documentElement.getAttribute('data-lang') || 'en-US';
+    this.theme = document.documentElement.getAttribute('theme') || 'light';
+    this.requestUpdate();
+  };
+
+  connectedCallback() {
+    this.updateData();
+
+    this.observer.observe(document.documentElement, { attributes: true });
+  }
+
+  requestUpdate() {
+    this.shadowRoot.innerHTML = this.render();
+  }
+
+  render() {
+    return `
+      ...
+    `;
+  }
+}
+
+customElements.define('demo-element', DemoElement);
+```
+
+```js script
+import '@rocket/launch/inline-notification/inline-notification.js';
 ```

docs/docs/markdown-javascript/story.md

@@ -2,10 +2,16 @@
 
 You can showcase live running code by annotating a code block with `js story`.
 
-````md
-```js story
-import { html } from 'lit-html';
+```js script
+import { html } from '@mdjs/mdjs-story';
+```
 
+````md
+```js script
+import { html } from '@mdjs/mdjs-story';
+```
+
+```js story
 export const foo = () => html` <p>my html</p> `;
 ```
 ````
@@ -13,7 +19,5 @@ export const foo = () => html` <p>my html</p> `;
 will result in
 
 ```js story
-import { html } from 'lit-html';
-
 export const foo = () => html` <p>my html</p> `;
 ```

docs/docs/presets/blog.md

@@ -1,6 +1,6 @@
-# Presets >> Blog ||30
+# Presets >> Blog ||40
 
-Enable writing blog posts within your rocket site
+Enable writing blog posts within your Rocket site.
 
 ## Installation
 

docs/docs/presets/joining-blocks.md

@@ -0,0 +1,95 @@
+# Presets >> Joining Blocks ||10
+
+The template system allows for a very granular control of how individual parts will be merged, overwritten or reorderd.
+
+As a preset you may want to add this to your layout.
+
+{% raw %}
+
+```
+<footer id="main-footer">
+  {% for blockName, blockPath in _joiningBlocks.footer %}
+    {% include blockPath %}
+  {% endfor %}
+</footer>
+```
+
+{% endraw %}
+
+This will now render all templates within `_includes/_joiningBlocks/footer/*`.
+
+## Adding content without overriding
+
+Let's assume we have a preset with the following files
+
+```html
+<!-- usedPreset/_includes/_joiningBlocks/footer/10-first.njk -->
+<p>first</p>
+
+<!-- usedPreset/_includes/_joiningBlocks/footer/20-second.njk -->
+<p>second</p>
+```
+
+And it produces this in your website
+
+```html
+<footer>
+  <p>first</p>
+  <p>second</p>
+</footer>
+```
+
+Now we can add a file which will insert content without needing to overwrite any of the preset file.
+
+```html
+<!-- docs/_includes/_joiningBlocks/footer/15-in-between.njk -->
+<p>in-between</p>
+```
+
+the final output will be
+
+```html
+<footer>
+  <p>first</p>
+  <p>in-between</p>
+  <p>second</p>
+</footer>
+```
+
+## Overriding Content
+
+Now if you want to overwrite you can use the same filename.
+
+```html
+<!-- docs/_includes/_joiningBlocks/footer/10-first.njk -->
+<p>updated first</p>
+```
+
+the final output will be
+
+```html
+<footer>
+  <p>updated first</p>
+  <p>second</p>
+</footer>
+```
+
+## Reordering and Overriding
+
+Sometimes you wanna reorder when you overwrite as well
+
+```html
+<!-- docs/_includes/_joiningBlocks/footer/30-first.njk -->
+<p>first</p>
+```
+
+the final output will be
+
+```html
+<footer>
+  <p>second</p>
+  <p>first</p>
+</footer>
+```
+
+Note: Reordering always requires you to overwrite as well.

docs/docs/presets/launch.md

@@ -1,6 +1,6 @@
-# Presets >> Launch ||10
+# Presets >> Launch ||20
 
-Rocket comes with a preset you will love. Simple, Responsive and behaving like native it sure is going to be a hit among your users.
+Rocket comes with a preset you will love. Simple, responsive and behaving like native, it sure is going to be a hit among your users.
 
 ## Installation
 
@@ -30,7 +30,7 @@ The footer data comes from `footer.json`
 
 Notification are web components that bring in some styles.
 
-To use them in Markdown you need to write the html tag and have it separated by an empty line.
+To use them in Markdown you need to write the HTML tag and have it separated by an empty line.
 
 ```js script
 import '@rocket/launch/inline-notification/inline-notification.js';
@@ -62,7 +62,7 @@ I am a tip
 </inline-notification>
 ```
 
-### Modify the title
+### Modify the Title
 
 To override the title you can provide a property success.
 

docs/docs/presets/search.md

@@ -1,4 +1,4 @@
-# Presets >> Search ||20
+# Presets >> Search ||30
 
 Add a search for all your static content.
 

docs/docs/tools/check-html-links.md

@@ -1,6 +1,16 @@
-# Tools >> Check Html Links ||30
+# Tools >> Check HTML Links ||30
 
-A fast checker for broken links/references in html.
+```js
+import '@rocket/launch/inline-notification/inline-notification.js';
+```
+
+A fast checker for broken links/references in HTML.
+
+<inline-notification type="tip">
+
+Read the [Introducing Check HTMl Links - no more bad links](../../blog/introducing-check-html-links.md) Blog post to find out how it came to be and how it works.
+
+</inline-notification>
 
 ## Features
 
@@ -8,7 +18,7 @@ A fast checker for broken links/references in html.
 - Focuses on the broken reference targets and groups references to it
 - Fast (can process 500-1000 documents in ~2-3 seconds)
 - Has only 3 dependencies (and 19 in the full tree)
-- Uses [sax-wasm](https://github.com/justinwilaby/sax-wasm) for parsing streamed html
+- Uses [sax-wasm](https://github.com/justinwilaby/sax-wasm) for parsing streamed HTML
 
 ## Installation
 
@@ -16,17 +26,32 @@ A fast checker for broken links/references in html.
 npm i -D check-html-links
 ```
 
-## Usage
+## CLI flags
 
-```
+| Name                | Type    | Description                                                                                         |
+| ------------------- | ------- | --------------------------------------------------------------------------------------------------- |
+| root-dir            | string  | the root directory to serve files from. Defaults to the current working directory                   |
+| ignore-link-pattern | string  | do not check links matching the pattern                                                             |
+| continue-on-error   | boolean | if present it will not exit with an error code - useful while writing or for temporary passing a ci |
+
+## Usage Examples
+
+```bash
+# check a folder _site
 npx check-html-links _site
+
+# ignore all links like <a href="/users/123">
+npx check-html-links _site --ignore-link-pattern "/users/*" "/users/**/*"
+
+# ignore all links like <a href="/users/123"> & <a href="/users/123/details">
+npx check-html-links _site --ignore-link-pattern "/users/*" "/users/**/*"
 ```
 
 ## Example Output
 
 ![Test Run Screenshot](./images/check-html-links-screenshot.png)
 
-## Comparision
+## Comparison
 
 Checking the output of [11ty-website](https://github.com/11ty/11ty-website) with 13 missing reference targets (used by 516 links) while checking 501 files. (on January 17, 2021)
 

docs/docs/tools/plugins-manager.md

@@ -34,7 +34,7 @@ var processor = unified().use(markdown).use(toc, { maxDepth: 2 });
 // ...
 ```
 
-## Problem statement
+## Problem Statement
 
 > Executing or adding a plugin in a special way is a one time process. You can not transparently later change the options of the given plugin.
 
@@ -42,7 +42,7 @@ This means if you wish to define default plugins and allow your user to override
 
 ## Solution
 
-The plugins manager let's you orchestrate a set of "meta plugins" which are defined by
+The plugins manager lets you orchestrate a set of "meta plugins" which are defined by
 
 - name
 - plugin
@@ -193,7 +193,7 @@ adjustPluginOptions('json', false);
 // resulting options = false
 ```
 
-## Converting metaPlugins to an actual plugin
+## Converting metaPlugins to an Actual Plugin
 
 To execute all setup function you can use this little helper
 

docs/docs/tools/rollup-config.md

@@ -1,15 +1,14 @@
 # Tools >> Rollup Config ||20
 
 Rollup configuration to help you get started building modern web applications.
-You write modern javascript using the latest browser-features, rollup will optimize your code for production and ensure it runs on all supported browsers.
+You write modern JavaScript using the latest browser features. Rollup will optimize your code for production and ensure it runs on all supported browsers.
 
 ## Features
 
-- Set HTML or JS as input and/or output
+- Set HTML or JavaScript as input and/or output
 - Optimized for browsers which support modules
 - Loads polyfills using feature detection
-- Generates a service worker
-- Minifies JS
+- Minifies JavaScript
 - Minifies lit-html templates
 
 ## Setup
@@ -25,7 +24,7 @@ You write modern javascript using the latest browser-features, rollup will optim
    ```js
    import { createSpaConfig } from '@rocket/building-rollup';
    // use `import { createBasicConfig }` to do regular JS to JS bundling
-   // use `import { createMpaConfig }` to bundle multiple html files
+   // use `import { createMpaConfig }` to bundle multiple HTML files
 
    export default createSpaConfig({
      input: 'index.html',
@@ -54,7 +53,7 @@ Our config sets you up with good defaults for most projects. Additionally you ca
 
 We use the [plugins-manager](./plugins-manager.md) for it.
 
-### Customizing the babel config
+### Customizing the Babel Config
 
 You can define custom babel plugins to be loaded by adding a `.babelrc` or `babel.config.js` to your project. See [babeljs config](https://babeljs.io/docs/en/configuration) for more information.
 
@@ -66,9 +65,9 @@ For example to add support for class properties:
 }
 ```
 
-### Customizing default plugins
+### Customizing Default Plugins
 
-Our config creators install a number of rollup plugins by default:
+Our config creators install a number of Rollup plugins by default:
 
 Basic, SPA and MPA plugins:
 

docs/guides/configuration/getting-started.md

@@ -16,11 +16,11 @@ export default /** @type {Partial<import('@rocket/cli').RocketCliOptions>} */ ({
 });
 ```
 
-The Plugins Manager helps you register and execute your plugins across the various Rocket components - rollup, dev-server, eleventy, and markdown. It replaces the specific registration/execution call in a given plugin system by an intent to use that plugin.
+The Plugins Manager helps you register and execute your plugins across the various Rocket components - Rollup, Web Dev Server, Eleventy, and Markdown. It replaces the specific registration/execution call in a given plugin system by an intent to use that plugin.
 
 ## Adding Remark/Unified Plugins
 
-If you want to a plugin to the markdown processing you can use `setupUnifiedPlugins`.
+If you want to a plugin to the Markdown processing you can use `setupUnifiedPlugins`.
 
 ```js
 import emoji from 'remark-emoji';
@@ -34,5 +34,5 @@ const config = {
 export default config;
 ```
 
-For plugins that should handle the markdown <abbr title="Abstract Syntax Tree">AST</abbr> you should use `addPlugin({ location: 'markdown', name: 'my-plugin', plugin: MyPlugin})`. <br>
-While for the rehype ast you should use `addPlugin({ location: 'remark2rehype', name: 'my-plugin', plugin: MyPlugin})`.
+For plugins that should handle the Markdown <abbr title="Abstract Syntax Tree">AST</abbr> you should use `addPlugin({ location: 'markdown', name: 'my-plugin', plugin: MyPlugin})`. <br>
+While for the rehype AST you should use `addPlugin({ location: 'remark2rehype', name: 'my-plugin', plugin: MyPlugin})`.

docs/guides/first-pages/adding-pages.md

@@ -8,9 +8,9 @@ It can help to examine each new page and menu carefully, to come to terms with t
 
 </inline-notification>
 
-## Add a section
+## Add a Section
 
-In most cases you will have multiple sections in your website and each of those sections will come with it's own sidebar navigation.
+In most cases you will have multiple sections in your website and each of those sections will come with its own sidebar navigation.
 
 To create a section you need to create a folder with an `index.md`.
 
@@ -38,7 +38,7 @@ Don't worry if this isn't how you would have styled or placed your menu bar or s
 
 It might be more practical to stay below 5 sections.
 
-## Adding a category
+## Adding a Category
 
 Often each section will have multiple categories.
 
@@ -54,7 +54,7 @@ mkdir docs/guides/first-pages/
 # First Pages
 ```
 
-## Adding a page to a category
+## Adding a Page to a Category
 
 👉 `docs/guides/first-pages/getting-started.md`
 
@@ -64,14 +64,14 @@ mkdir docs/guides/first-pages/
 This is how you get started.
 ```
 
-## Headings as anchor and menu items
+## Headings as Anchor and Menu Items
 
 _**Within**_ any page, you can still add links to your navigation!
 
-Note that md text prefixed with one or two # signs also becomes and anchor in the page and a link in the sidebar navigation when the page is open.
+Note that Markdown text prefixed with one or two # signs also becomes an anchor in the page and a link in the sidebar navigation when the page is open.
 
 ```md
-## Headings as anchor and menu items
+## Headings as Anchor and Menu Items
 
 _**Within**_ any page, you can still add links to your navigation!
 ```
@@ -80,6 +80,6 @@ _**Within**_ any page, you can still add links to your navigation!
 import '@rocket/launch/inline-notification/inline-notification.js';
 ```
 
-## Example as a reference
+## Example as a Reference
 
 If implicit navigation, derived from content, is a bit too much to grasp in one sitting, feel free to examine the **docs** folder in [the rocket codebase behind the pages you are reading](https://github.com/modernweb-dev/rocket) for more examples.

docs/guides/first-pages/getting-started.md

@@ -1,6 +1,6 @@
 # First Pages >> Getting Started ||10
 
-Rocket is has the following prerequisits:
+Rocket has the following prerequisites:
 
 - [Node 14+](https://nodejs.org/en/)
 
@@ -37,7 +37,7 @@ The fastest way to get started is by using an existing preset like the launch pr
 
 You may be tempted to skip the step above, because you're not ready to commit to git yet!
 
-Rocket uses the .gitignore file to manage it's requirements. If you skip this step, rocket will fail to deploy!
+Rocket uses the .gitignore file to manage its requirements. If you skip this step, Rocket will fail to deploy!
 
 </inline-notification>
 
@@ -62,25 +62,25 @@ Rocket uses the .gitignore file to manage it's requirements. If you skip this st
 
 <inline-notification type="warning" title="note">
 
-All further pathes are relative to your project root (my-project in this case)
+All further paths are relative to your project root (my-project in this case).
 
 </inline-notification>
 
-## Add your first page
+## Add your First Page
 
 👉 `docs/index.md`
 
 ```md
-# Welcome to your Rocket site
+# Welcome to Your Rocket Site
 
-Text here, like any markdown file.
+Text here, like any Markdown file.
 ```
 
 This tutorial assumes you are familiar with Markdown, for page authoring.
 
 Please note that the heading - text prefixed with `#` or `##` - is not optional for each page in this tutorial. Everything below that first line is optional Markdown text.
 
-## Start up:
+## Startup:
 
 👉 `package.json`
 

docs/guides/first-pages/layouts.md

@@ -0,0 +1,29 @@
+# First Pages >> Layouts ||60
+
+The following templates are always available:
+
+- `layout-raw` No html or any wrapping (use it for xml, json, ... outputs)
+- `layout-default` For content
+- `layout-index` Extends content and adds an "Open Navigation" button for mobile
+
+Layout Default has the following Joining Blocks:
+
+- `head` For the html `<head>`
+- `header` Within the top `<header>`
+- `content` Html within the main content section
+- `footer` Within to bottom `<footer>`
+- `bottom` Add the end of the body
+
+## Launch Preset
+
+On top of the above it adds the following templates
+
+- `layout-404` A space not found page
+- `layout-home` Frontpage with center logo below text
+- `layout-home-background` Frontpage with left text and background image on the right
+- `layout-sidebar` Left sidebar, right content
+- `layout-index` Extends layout-sidebar
+
+And the following changes
+
+- Sets `layout-sidebar` as the default layout

docs/guides/first-pages/link-to-other-pages.md

@@ -1,6 +1,6 @@
 # First Pages >> Linking ||20
 
-Standard markdown applies and you can link via
+Standard Markdown applies. You can link like this:
 
 ```md
 [visible label](./path/to/other-file.md)

docs/guides/first-pages/manage-sidebar.md

@@ -21,7 +21,7 @@ Will be ordered as `First`, `Second`,
 
 ## How it works
 
-Internally `# Foo >> Bar >> Baz ||20` get's converted to.
+Internally `# Foo >> Bar >> Baz ||20` gets converted to.
 
 ```
 ---
@@ -47,3 +47,9 @@ export const headlineConverter = () => html`
 ```
 
 How it then works is very similar to https://www.11ty.dev/docs/plugins/navigation/
+
+## Sidebar redirects
+
+By default, the sidebar nav redirects clicks on category headings to the first child page in that category.
+
+To disable those redirects, override `_includes/_joiningBlocks/_layoutSidebar/sidebar/20-navigation.njk` and add the `no-redirects` attribute to the `<rocket-navigation>` element.

docs/guides/first-pages/urls.md

@@ -1,5 +1,5 @@
-# First Pages >> Urls ||100
+# First Pages >> URLs ||50
 
-Urls will be represented by the folder structure...
+URLs will be represented by the folder structure.
 
-You can use a frontmatter with permalink to override
+You can use front matter with a [permalink](https://www.11ty.dev/docs/permalinks/) to override.

docs/guides/first-pages/use-javascript.md

@@ -1,6 +1,6 @@
 # First Pages >> Use JavaScript ||40
 
-You can use `js script` to execute javascript (type = module)
+You can use `js script` to execute JavaScript (`type="module"`).
 
 ````
 ```js script
@@ -8,7 +8,7 @@ console.log('foo');
 ```
 ````
 
-This can be useful for importing web components and using them in markdown
+This can be useful for importing web components and using them in Markdown.
 
 ````
 ```js script
@@ -16,7 +16,7 @@ import 'magic-reveal/magic-reveal.js';
 
 <magic-reveal>
 
-This text will get magically revealed. I can **still** use markdown as long as between the opening/closing tag there is an empty line.
+This text will get magically revealed. I can **still** use Markdown as long as there is an empty line between the opening/closing tags and my text.
 
 </magic-reveal>
 ```

docs/guides/go-live/overview.md

@@ -2,29 +2,29 @@
 
 A few things are usually needed before going live "for real".
 
-## Add a not found page
+## Add a Not Found Page
 
-When a user enters a url that does not exists then a "famous" 404 page not found error occures.
+When a user enters a URL that does not exist, a "famous" 404 Page Not Found error occurs.
 Many servers are configured to handle this automatically and to serve a 404.html page instead.
 
-The [Rocket Lauch Preset](../../docs/presets/launch.md) ships a default 404 template you can use.
+The [Rocket Launch preset](../../docs/presets/launch.md) ships a default 404 template you can use.
 
-To enable it you need to creating a 404.md and use the 404 layout.
+To enable it, you need to create a 404.md and use the 404 layout.
 
 👉 `docs/404.md`
 
 ```
 ---
-layout: 404.njk
+layout: layout-404
 permalink: 404.html
 ---
 ```
 
-## Add a sitemap
+## Add a Sitemap
 
 A sitemap can be used to inform search engines or services about the pages your site has.
 
-You can create one by adding this file
+You can create one by adding this file:
 
 👉 `docs/sitemap.njk`
 
@@ -32,7 +32,7 @@ You can create one by adding this file
 
 ```
 ---
-layout: pure-content.njk
+layout: layout-raw
 permalink: /sitemap.xml
 eleventyExcludeFromCollections: true
 ---

docs/guides/go-live/social-media.md

@@ -3,13 +3,15 @@
 Having a nice preview image for social media can be very helpful.
 For that reason Rocket creates those automatically with the title, parent title, section and your logo.
 
-It will look like this but with your logo
+It will look like this but with your logo:
 
-<img src="{{ socialMediaImage }}" width="1200" height="630" alt="Social Media Image of this page" style="border: 1px solid #000" />
+<img src="{{ socialMediaImage | url }}" width="1200" height="630" alt="Social Media Image of this page" style="border: 1px solid #000" />
 
 There are multiple ways you can modify it.
 
-## Setting it via frontMatter
+Note: If your logo has an `<?xml>` tag it will throw an error as it will be inlined into this SVG and nested XML tags are not allowed.
+
+## Setting it via Front Matter
 
 You can create your own image and link it with something like this
 
@@ -19,26 +21,133 @@ socialMediaImage: path/to/my/image.png
 ---
 ```
 
-## Providing your own text
+## Providing Your Own Text
 
 Sometimes extracting the title + title of parent is not enough but you still want to use the "default image".
 
 You can create an `11tydata.cjs` file next to your page. If your page is `docs/guides/overview.md` then you create a `docs/guides/overview.11tydata.cjs`.
 
-In there you can use the default `createPageSocialImage` but provide your own values.
+In there you can use the default `createSocialImage` but provide your own values.
 
 ```js
-const { createPageSocialImage } = require('@rocket/cli');
+const { createSocialImage } = require('@rocket/cli');
 
 module.exports = async function () {
-  const socialMediaImage = await createPageSocialImage({
+  const socialMediaImage = await createSocialImage({
     title: 'Learning Rocket',
     subTitle: 'Have a website',
     subTitle2: 'in 5 Minutes',
     footer: 'Rocket Guides',
+    // you can also override the svg only for this page by providing
+    // createSocialImageSvg: async () => '<svg>...</svg>'
   });
   return {
     socialMediaImage,
   };
 };
 ```
+
+## Override the Default Image
+
+Often you want to have a unique style for your social media images.
+For that you can provide your own function which returns a string of an SVG to render the image.
+
+👉 `rocket.config.mjs`
+
+```js
+import { adjustPluginOptions } from 'plugins-manager';
+
+/** @type {Partial<import("@rocket/cli").RocketCliOptions>} */
+const config = {
+  setupEleventyComputedConfig: [
+    adjustPluginOptions('socialMediaImage', {
+      createSocialImageSvg: async ({
+        title = '',
+        subTitle = '',
+        subTitle2 = '',
+        footer = '',
+        logo = '',
+      }) => {
+        let svgStr = `
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1200 630" style="fill: #ecedef;">
+            <defs/>
+            <rect width="100%" height="100%" fill="#38393e"/>
+            <g transform="matrix(0.45, 0, 0, 0.45, 300, 60)">${logo}</g>
+            <g style="
+              font-size: 70px;
+              text-anchor: middle;
+              font-family: 'Bitstream Vera Sans','Helvetica',sans-serif;
+              font-weight: 700;
+            ">
+              <text x="50%" y="470">
+                ${title}
+              </text>
+              <text x="50%" y="520" style="font-size: 30px;">
+                ${subTitle}
+              </text>
+            </g>
+            <text x="10" y="620" style="font-size: 30px; fill: gray;">
+              ${footer}
+            </text>
+          </svg>
+        `;
+        return svgStr;
+      },
+    }),
+  ],
+};
+
+export default config;
+```
+
+## Using an SVG File as a src with Nunjucks
+
+If you have multiple variations it may be easier to save them as SVG files and use a template system.
+
+WARNING: Untested example
+
+👉 `rocket.config.mjs`
+
+{% raw %}
+
+```js
+import { adjustPluginOptions } from 'plugins-manager';
+
+/** @type {Partial<import("@rocket/cli").RocketCliOptions>} */
+const config = {
+  setupEleventyComputedConfig: [
+    adjustPluginOptions('socialMediaImage', {
+      createSocialImageSvg: async (args = {}) => {
+        // inside of the svg you can use {{ title }}
+        const svgBuffer = await fs.promises.readFile('/path/to/your/svg/file');
+        const svg = logoBuffer.toString();
+        return nunjucks.renderString(svg, args);
+      },
+    }),
+  ],
+};
+
+{% endraw %}
+```
+
+## Enabling / Disabling
+
+Generating images from SVG is quite fast but it can still add that's why by default during `rocket start` there will be no social media images created.
+
+If you with so create them also during start you can
+
+```js
+const config = {
+  start: {
+    createSocialMediaImages: true,
+  },
+};
+```
+
+Similarly, if you never want to create social media images even during build then you can globally disable it via
+
+```js
+const config = {
+  createSocialMediaImages: true,
+};
+```

docs/guides/index.11tydata.cjs

@@ -1,7 +1,7 @@
-const { createPageSocialImage } = require('@rocket/cli');
+const { createSocialImage } = require('@rocket/cli');
 
 module.exports = async function () {
-  const socialMediaImage = await createPageSocialImage({
+  const socialMediaImage = await createSocialImage({
     title: 'Learning Rocket',
     subTitle: 'Have a website',
     subTitle2: 'in 5 Minutes',

docs/guides/presets/create-your-own.md

@@ -1,7 +1,106 @@
 # Presets >> Create your own || 90
 
-All loaded presets will be combined but you can override each file.
+A preset is a setup function and a folder including `_assets`, `_data` and `_includes` (all optional).
 
-Take a look at `docs/_merged_includes` and override what you want to override by placing the same filename into `_includes`.
+To play around with a preset you can create a folder `fire-theme`.
 
-Also works for `_assets`, `_data` ...
+You then create the setup function for it with only one property called `path` which will allow Rocket to properly resolve it.
+
+## Create a Preset Config File
+
+👉 `fire-theme/fireTheme.js`
+
+```js
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+export function fireTheme() {
+  return {
+    path: path.resolve(__dirname),
+  };
+}
+```
+
+Once you have that you can start filling in content you need.
+
+For example a we could override the full `layout.css` by adding a it like so
+
+👉 `fire-theme/layout.css`
+
+```css
+body {
+  background: hotpink;
+}
+```
+
+Once you have that you can add it to your Rocket config.
+
+NOTE: The order of presets is important, as for example in this case we take everything from `rocketLaunch` but later override via `fireTheme`.
+
+👉 `rocket-config.js`
+
+```js
+import { rocketLaunch } from '@rocket/launch';
+import { fireTheme } from 'path/to/fire-theme/fireTheme.js';
+
+export default {
+  presets: [rocketLaunch(), fireTheme()],
+};
+```
+
+## Publish a Preset
+
+If you would like to publish a preset to use it on multiple websites or share it with your friends you can do like so.
+
+1. Pick a name for the package => for this example we take `fire-theme`.
+2. Create a new folder `fire-theme`
+3. Create a folder `fire-theme/preset` copy `fireTheme.js` from [above](#create-a-preset-config-file) into `preset/fireTheme.js`
+4. Add a 👉 `package.json`
+
+   ```json
+   {
+     "name": "fire-theme",
+     "version": "0.3.0",
+     "description": "Fire Theme for Rocket",
+     "license": "MIT",
+     "type": "module",
+     "exports": {
+       ".": "./index.js",
+       "./preset/": "./preset/"
+     },
+     "files": ["*.js", "preset"],
+     "keywords": ["rocket", "preset"]
+   }
+   ```
+
+5. Add a 👉 `index.js`
+
+   ```js
+   export { fireTheme } from './preset/fireTheme.js';
+   ```
+
+6. Add a 👉 `README.md`
+
+   ````
+   # FireTheme
+
+   This is a theme/preset for [Rocket](https://rocket.modern-web.dev/).
+
+   ## Installation
+
+   ```
+   npm i -D fire-theme
+   ```
+
+   Add it to your 👉 `rocket.config.js`
+
+   ```js
+   import { fireTheme } from 'fire-theme';
+
+   export default {
+     presets: [fireTheme()],
+   };
+   ```
+   ````

docs/guides/presets/using-templates.md

@@ -1,3 +1,59 @@
 # Presets >> Using templates ||30
 
-Most presetse have specific entry files you can override...
+The template system allows for very granular control of how individual parts will be merged, overwritten, or reordered.
+
+On top of the [Overriding](./overriding.md) you can do with the presets alone templates have another superpower and that is automatically joining of parts.
+
+It is generally preferred to use `Joining Blocks` before overriding.
+
+## Adding html to the html head
+
+Often you will want to load some more fonts or an additional CSS file. You can do so by adding a file to the head Joining Block.
+
+👉 `docs/_includes/_joiningBlocks/head/additional-styles.njk`
+
+```html
+<link rel="stylesheet" href="{{ '/_assets/additional-styles.css' | asset | url }}" />
+```
+
+This will add the html at the bottom of the head.
+
+## Adding JavaScript to the bottom of the body
+
+For executing a script you can use the `bottom` Joining Block.
+
+👉 `docs/_includes/_joiningBlocks/bottom/my-script.njk`
+
+```html
+<script>
+  console.log('hello world');
+</script>
+```
+
+If you look into `docs/_merged_includes/_joiningBlocks/bottom/` you will see a few scripts
+
+- `10-init-navigation.njk`
+- `180-service-worker-update.njk`
+- `190-google-analytics.njk`
+- `my-script.njk`
+
+## Controlling the order
+
+In the html `<head>` order is usually not that important but when adding script it does.
+
+If you look into the dom then you see that its order matches with the file system order.
+
+Now if you want to move your script in-between `init-nagivation` and `service-worker-update` then you can rename your file to
+
+👉 `docs/_includes/_joiningBlocks/bottom/20-my-script.njk`
+
+which brings the order to
+
+- `10-init-navigation.njk`
+- `20-my-script.njk`
+- `180-service-worker-update.njk`
+- `190-google-analytics.njk`
+
+## More information
+
+For more details please see the [Joining Blocks Docs](../../docs/presets/joining-blocks.md)

docs/index.11tydata.cjs

@@ -1,7 +1,7 @@
-const { createPageSocialImage } = require('@rocket/cli');
+const { createSocialImage } = require('@rocket/cli');
 
 module.exports = async function () {
-  const socialMediaImage = await createPageSocialImage({
+  const socialMediaImage = await createSocialImage({
     title: 'Rocket',
     subTitle: 'Static sites with',
     subTitle2: 'a sprinkle of JavaScript.',

docs/index.md

@@ -1,6 +1,6 @@
 ---
 title: Rocket
-layout: home.njk
+layout: layout-home-background
 slogan: The modern web setup for static sites with a sprinkle of JavaScript.
 callToActionItems:
   - text: Follow Guides
@@ -12,11 +12,11 @@ reasons:
   - header: Small
     text: No overblown tools or frontend frameworks, add JavaScript and/or Web Components only on pages where needed.
   - header: Pre-Rendered
-    text: Statically generated content means less javascript to ship and process.
+    text: Statically generated content means less JavaScript to ship and process.
   - header: Zero Configuration
-    text: Automatic code splitting, filesystem based routing, and javascript in markdown.
+    text: Automatic code splitting, filesystem based routing, and JavaScript in Markdown.
   - header: Meta Framework
-    text: 'Build on top of giants like <a href="https://www.11ty.dev/">eleventy</a>, <a href="https://rollupjs.org/">Rollup</a>, and <a href="https://www.modern-web.dev/">Modern Web</a>.'
+    text: 'Build on top of giants like <a href="https://www.11ty.dev/">Eleventy</a>, <a href="https://rollupjs.org/">Rollup</a>, and <a href="https://www.modern-web.dev/">Modern Web</a>.'
   - header: Powerful Default Template
     text: Provide content and you are ready to go.
   - header: Ready for Production

docs/simulator.md

@@ -0,0 +1,5 @@
+---
+layout: layout-simulator
+eleventyExcludeFromCollections: true
+excludeFromSearch: true
+---

docs/sitemap.njk

@@ -1,5 +1,5 @@
 ---
-layout: pure-content.njk
+layout: layout-raw
 permalink: /sitemap.xml
 eleventyExcludeFromCollections: true
 ---

package.json

@@ -28,7 +28,7 @@
     "release": "changeset publish && yarn format",
     "rocket:build": "node packages/cli/src/cli.js build",
     "search": "node packages/cli/src/cli.js search",
-    "setup": "npm run setup:ts-configs",
+    "setup": "npm run setup:ts-configs && npm run build:packages",
     "setup:patches": "npx patch-package",
     "setup:ts-configs": "node scripts/generate-ts-configs.mjs",
     "start": "node packages/cli/src/cli.js start",
@@ -45,7 +45,7 @@
   },
   "devDependencies": {
     "@changesets/cli": "^2.12.0",
-    "@open-wc/testing": "^2.5.32",
+    "@open-wc/testing": "^3.0.0-next.1",
     "@rollup/plugin-commonjs": "^17.0.0",
     "@rollup/plugin-json": "^4.1.0",
     "@rollup/plugin-typescript": "^8.1.0",
@@ -75,14 +75,14 @@
     "onchange": "^7.1.0",
     "prettier": "^2.2.1",
     "prettier-plugin-package": "^1.3.0",
-    "puppeteer": "^5.5.0",
+    "puppeteer": "^9.0.0",
     "remark-emoji": "^2.1.0",
     "rimraf": "^3.0.2",
     "rollup": "^2.36.1",
     "rollup-plugin-terser": "^7.0.2",
     "sinon": "^9.2.3",
     "ts-node": "^9.1.1",
-    "typescript": "^4.1.3"
+    "typescript": "^4.3.2"
   },
   "eslintConfig": {
     "parser": "@typescript-eslint/parser",

packages/blog/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @rocket/blog
 
+## 0.3.0
+
+### Minor Changes
+
+- 8bdc326: Adopt to new layout system
+
+  BREAKING CHANGE:
+
+  - Renamed `blog` to `layout-blog-overview`
+  - Renamed `post` to `layout-blog-details`
+
 ## 0.2.0
 
 ### Minor Changes

packages/blog/README.md

@@ -1,5 +1,5 @@
 # Blog Preset for Rocket
 
-Add blog posts to your rocket site.
+Add blog posts to your Rocket site.
 
 For docs please see our homepage [https://rocket.modern-web.dev/docs/presets/blog/](https://rocket.modern-web.dev/docs/presets/blog/).

packages/blog/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rocket/blog",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "publishConfig": {
     "access": "public"
   },
@@ -38,6 +38,6 @@
     "testing"
   ],
   "dependencies": {
-    "plugins-manager": "^0.2.0"
+    "plugins-manager": "^0.2.2"
   }
 }

packages/blog/preset/_assets/rocket-blog.css

@@ -1,10 +1,10 @@
 /** BLOG OVERVIEW **************************************************************************/
 
-body[layout='blog-details'] rocket-navigation > ul > li.current::before {
+body[layout='layout-blog-details'] rocket-navigation > ul > li.current::before {
   display: none;
 }
 
-body[layout='blog-details'] #sidebar-nav li.anchor a:hover::before {
+body[layout='layout-blog-details'] #sidebar-nav li.anchor a:hover::before {
   display: none;
 }
 
@@ -48,8 +48,7 @@ body[layout='blog-details'] #sidebar-nav li.anchor a:hover::before {
 }
 
 @media screen and (min-width: 1024px) {
-	body[layout='blog-details'] #sidebar {
+	body[layout='layout-blog-details'] #sidebar {
     display: block;
 	}
 }
-

packages/blog/preset/_includes/_joiningBlocks/_layoutBlogDetails/content/10-title.njk

@@ -0,0 +1,3 @@
+{% if cover_image %}
+  <img src="{{ cover_image | url }}" alt="">
+{% endif %}

packages/blog/preset/_includes/_joiningBlocks/_layoutBlogDetails/content/30-footer.njk

@@ -0,0 +1 @@
+{% include 'partials/_shared/blog-content-footer.njk' %}

packages/blog/preset/_includes/_joiningBlocks/_layoutBlogDetails/sidebar/10-logo.njk

@@ -0,0 +1 @@
+{% include 'partials/_shared/logoLink.njk' %}

packages/blog/preset/_includes/_joiningBlocks/_layoutBlogDetails/sidebar/20-navigation.njk

@@ -0,0 +1,25 @@
+<rocket-navigation>
+  <ul>
+    <li class="current">
+      <h3>Headings</h3>
+      {{ collections[section] | rocketPageAnchors({ title: title }) | rocketNavToHtml({
+      listItemClass: "menu-item",
+      activeListItemClass: "current",
+      activeKey: eleventyNavigation.key
+  }) | safe }}
+    </li>
+  </ul>
+  <div class="sidebar-tags">
+    <h3>Date</h3>
+    <div>{{ page.date.toDateString() }}</div>
+  </div>
+  <div class="sidebar-tags">
+    <h3>Tags</h3>
+    <div class="tags">
+      {% for tag in tags %}
+        <span class="tag">{{tag}}</span>
+      {% endfor %}
+    </div>
+  </div>
+  {% include 'partials/mobile-sidebar-bottom.njk' %}
+</rocket-navigation>

packages/blog/preset/_includes/_joiningBlocks/_layoutBlogOverview/content/30-articles.njk

@@ -0,0 +1,20 @@
+<div class="articles">
+  {% for post in posts %}
+    {% if post.data.published %}
+      <article>
+        {% if post.data.cover_image %}
+          <a href="{{ post.url | url }}">
+            <img src="{{ post.data.cover_image | url }}" alt="">
+          </a>
+        {% endif %}
+        <div class="content">
+          <h2>
+            <a href="{{ post.url | url }}">{{ post.data.title }}</a>
+          </h2>
+          <p>{{ post.data.description }}</p>
+          <a class="read" href="{{ post.url | url }}">...read more</a>
+        </div>
+      </article>
+    {% endif %}
+  {% endfor %}
+</div>

packages/blog/preset/_includes/_joiningBlocks/head/add-blog-css.njk

@@ -0,0 +1 @@
+<link rel="stylesheet" href="{{ '/_assets/rocket-blog.css' | asset | url }}">

packages/blog/preset/_includes/blog-details.njk

@@ -1,57 +0,0 @@
-{% extends 'with-index.njk' %}
-
-{% block headContent %}
-  {{ super() }}
-  <link rel="stylesheet" href="{{ '/_assets/blog.css' | asset | url }}">
-{% endblock %}
-
-{% block bodyTag %}
-  <body layout="blog-details">
-{% endblock bodyTag %}
-
-{% block sidebar %}
-  <rocket-drawer id="sidebar">
-    <nav slot="content" id="sidebar-nav">
-      {% include 'partials/logoLink.njk' %}
-      <rocket-navigation>
-        <ul>
-          <li class="current">
-            <h3>Headings</h3>
-            {{ collections[section] | rocketPageAnchors({ title: title }) | rocketNavToHtml({
-            listItemClass: "menu-item",
-            activeListItemClass: "current",
-            activeKey: eleventyNavigation.key
-        }) | safe }}
-          </li>
-        </ul>
-        <div class="sidebar-tags">
-          <h3>Date</h3>
-          <div>{{ page.date.toDateString() }}</div>
-        </div>
-        <div class="sidebar-tags">
-          <h3>Tags</h3>
-          <div class="tags">
-            {% for tag in tags %}
-              <span class="tag">{{tag}}</span>
-            {% endfor %}
-          </div>
-        </div>
-        {% include 'partials/mobile-sidebar-bottom.njk' %}
-      </rocket-navigation>
-    </nav>
-  </rocket-drawer>
-{% endblock sidebar %}
-
-{% block main %}
-  <main class="markdown-body">
-    {% if cover_image %}
-      <img src="{{ cover_image | url }}" alt="">
-    {% endif %}
-    {% include 'partials/addTitleHeadline.njk' %}
-
-    {{ content | safe }}
-
-    {% include 'partials/previousNext.njk' %}
-    {% include 'partials/blog-content-footer.njk' %}
-  </main>
-{% endblock main %}

packages/blog/preset/_includes/blog-overview.njk

@@ -1,37 +0,0 @@
-{% extends 'home.njk' %}
-
-{% block headContent %}
-  {{ super() }}
-  <link rel="stylesheet" href="{{ '/_assets/blog.css' | asset | url }}">
-{% endblock %}
-
-{% block bodyTag %}
-  <body layout="blog-overview">
-{% endblock bodyTag %}
-
-{% block main %}
-  <main class="markdown-body">
-    {% include 'partials/addTitleHeadline.njk' %}
-    {{ content | safe }}
-    <div class="articles">
-      {% for post in posts %}
-        {% if post.data.published %}
-          <article>
-            {% if post.data.cover_image %}
-              <a href="{{ post.url | url }}">
-                <img src="{{ post.data.cover_image | url }}" alt="">
-              </a>
-            {% endif %}
-            <div class="content">
-              <h2>
-                <a href="{{ post.url | url }}">{{ post.data.title }}</a>
-              </h2>
-              <p>{{ post.data.description }}</p>
-              <a class="read" href="{{ post.url | url }}">...read more</a>
-            </div>
-          </article>
-        {% endif %}
-      {% endfor %}
-    </div>
-  </main>
-{% endblock main %}

packages/blog/preset/_includes/layout-blog-details.njk

@@ -0,0 +1,11 @@
+{% extends 'layout-sidebar.njk' %}
+
+{% block sidebar %}
+	{% include 'partials/_layoutBlogDetails/sidebar.njk' %}
+{% endblock sidebar %}
+
+{% block content %}
+  <main class="markdown-body">
+    {% include 'partials/_layoutBlogDetails/content.njk' %}
+  </main>
+{% endblock content %}

packages/blog/preset/_includes/layout-blog-overview.njk

@@ -0,0 +1,5 @@
+{% extends 'layout-home.njk' %}
+
+{% block content %}
+  {% include 'partials/_layoutBlogOverview/content.njk' %}
+{% endblock content %}

packages/blog/preset/_includes/partials/_layoutBlogDetails/content.njk

@@ -0,0 +1,5 @@
+<main class="markdown-body">
+  {% for blockName, blockPath in _joiningBlocks._layoutBlogDetails.content %}
+    {% include blockPath %}
+  {% endfor %}
+</main>

packages/blog/preset/_includes/partials/_layoutBlogDetails/sidebar.njk

@@ -0,0 +1,7 @@
+<rocket-drawer id="sidebar">
+  <nav slot="content" id="sidebar-nav">
+    {% for blockName, blockPath in _joiningBlocks._layoutBlogDetails.sidebar %}
+      {% include blockPath %}
+    {% endfor %}
+  </nav>
+</rocket-drawer>

packages/blog/preset/_includes/partials/_layoutBlogOverview/content.njk

@@ -0,0 +1,5 @@
+<main class="markdown-body">
+  {% for blockName, blockPath in _joiningBlocks._layoutBlogOverview.content %}
+    {% include blockPath %}
+  {% endfor %}
+</main>

packages/blog/preset/rocketBlog.js

@@ -13,9 +13,6 @@ export function rocketBlog({ section = SECTION, postCollection = POST_COLLECTION
 
   const eleventyPluginRocketBlog = {
     configFunction: eleventyConfig => {
-      eleventyConfig.addLayoutAlias('blog', 'blog-overview.njk');
-      eleventyConfig.addLayoutAlias('post', 'blog-details.njk');
-
       eleventyConfig.addCollection('posts', collection => {
         /*
         // It's not working beacuse it's a paginated collection.
@@ -41,7 +38,7 @@ export function rocketBlog({ section = SECTION, postCollection = POST_COLLECTION
 
         const posts = eleventyConfig.collections[section](collection);
         posts.forEach(page => {
-          page.data.layout = 'post';
+          page.data.layout = 'layout-blog-details';
         });
         return posts;
       });

packages/building-rollup/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @rocket/building-rollup
 
+## 0.3.1
+
+### Patch Changes
+
+- 60e85a1: Support `picture` tags by handling `source` tags with `srcset` attributes in the rollup asset gathering build phase.
+
+## 0.3.0
+
+### Minor Changes
+
+- 2724f07: Stop auto generating a service worker from a template. Setup your own and then bundle via `createServiceWorkerConfig`.
+
+## 0.2.0
+
+### Minor Changes
+
+- bad4686: Preserve attributes on script tags. Preserve export names.
+
+## 0.1.3
+
+### Patch Changes
+
+- be0d0b3: fix: add missing main entry to the packages
+
 ## 0.1.2
 
 ### Patch Changes

packages/building-rollup/README.md

@@ -1,6 +1,6 @@
 # Building Rollup
 
 Rollup configuration to help you get started building modern web applications.
-You write modern javascript using the latest browser-features, rollup will optimize your code for production and ensure it runs on all supported browsers.
+You write modern JavaScript using the latest browser features. Rollup will optimize your code for production and ensure it runs on all supported browsers.
 
 For docs please see our homepage [https://rocket.modern-web.dev/docs/building/rollup-config/](https://rocket.modern-web.dev/docs/building/rollup-config/).

packages/building-rollup/demo/js/demo-app.js

@@ -2,7 +2,7 @@
 import { LitElement, html, css } from 'lit-element';
 import './demo-component.js';
 
-// partial css trips up the minifier
+// partial CSS trips up the minifier
 const fontSize = css`
   16
 `;

packages/building-rollup/demo/ts/demo-app.ts

@@ -1,6 +1,6 @@
 import { LitElement, html, customElement } from 'lit-element';
 
-const msg: string = 'Typescript demo works';
+const msg: string = 'TypeScript demo works';
 
 @customElement('demo-app')
 class DemoApp extends LitElement {

packages/building-rollup/index.js

@@ -6,3 +6,7 @@
 export { createBasicConfig, createBasicMetaConfig } from './src/createBasicConfig.js';
 export { createSpaConfig, createSpaMetaConfig } from './src/createSpaConfig.js';
 export { createMpaConfig, createMpaMetaConfig } from './src/createMpaConfig.js';
+export {
+  createServiceWorkerConfig,
+  createServiceWorkerMetaConfig,
+} from './src/createServiceWorkerConfig.js';

packages/building-rollup/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rocket/building-rollup",
-  "version": "0.1.2",
+  "version": "0.3.1",
   "publishConfig": {
     "access": "public"
   },
@@ -13,6 +13,7 @@
   },
   "author": "Modern Web <hello@modern-web.dev> (https://modern-web.dev/)",
   "homepage": "https://rocket.modern-web.dev/docs/tools/building-rollup/",
+  "main": "./index.js",
   "type": "module",
   "exports": {
     ".": "./index.js"
@@ -54,11 +55,16 @@
     "@babel/preset-env": "^7.12.11",
     "@rollup/plugin-babel": "^5.2.2",
     "@rollup/plugin-node-resolve": "^11.0.1",
-    "@web/rollup-plugin-html": "^1.4.0",
+    "@rollup/plugin-replace": "^2.4.2",
+    "@web/rollup-plugin-html": "^1.8.0",
     "@web/rollup-plugin-import-meta-assets": "^1.0.4",
-    "@web/rollup-plugin-polyfills-loader": "^1.0.3",
+    "@web/rollup-plugin-polyfills-loader": "^1.1.0",
     "browserslist": "^4.16.1",
     "rollup-plugin-terser": "^7.0.2",
-    "rollup-plugin-workbox": "^6.1.0"
+    "workbox-broadcast-update": "^6.1.5",
+    "workbox-cacheable-response": "^6.1.5",
+    "workbox-expiration": "^6.1.5",
+    "workbox-routing": "^6.1.5",
+    "workbox-strategies": "^6.1.5"
   }
 }

packages/building-rollup/src/createBasicConfig.js

@@ -22,7 +22,7 @@ export function createBasicMetaConfig(userConfig = { output: {} }) {
   const assetName = `[${developmentMode ? 'name' : 'hash'}][extname]`;
 
   const config = {
-    preserveEntrySignatures: false,
+    preserveEntrySignatures: 'strict',
     treeshake: !developmentMode,
     setupPlugins: [],
     ...userConfig,

packages/building-rollup/src/createMpaConfig.js

@@ -15,10 +15,6 @@ export function createMpaMetaConfig(userConfig = { output: {}, setupPlugins: []
     adjustPluginOptions('html', {
       flattenOutput: false,
     }),
-    adjustPluginOptions('workbox', config => {
-      delete config.navigateFallback;
-      return config;
-    }),
     ...config.setupPlugins,
   ];
 

packages/building-rollup/src/createServiceWorkerConfig.js

@@ -0,0 +1,91 @@
+import resolve from '@rollup/plugin-node-resolve';
+import { terser } from 'rollup-plugin-terser';
+import babelPkg from '@rollup/plugin-babel';
+import replace from '@rollup/plugin-replace';
+
+import { metaConfigToRollupConfig } from 'plugins-manager';
+
+const { babel } = babelPkg;
+
+export function createServiceWorkerConfig(userConfig) {
+  const { config, metaPlugins } = createServiceWorkerMetaConfig(userConfig);
+  return metaConfigToRollupConfig(config, metaPlugins);
+}
+
+export function createServiceWorkerMetaConfig(userConfig = { output: {} }) {
+  const developmentMode =
+    typeof userConfig.developmentMode !== undefined
+      ? userConfig.developmentMode
+      : !!process.env.ROLLUP_WATCH;
+  delete userConfig.developmentMode;
+
+  const config = {
+    treeshake: !developmentMode,
+    setupPlugins: [],
+    ...userConfig,
+
+    output: {
+      format: 'iife',
+      file: 'service-worker.js',
+      ...userConfig.output,
+    },
+  };
+
+  let metaPlugins = [
+    {
+      name: 'node-resolve',
+      plugin: resolve,
+      options: {
+        moduleDirectories: ['node_modules', 'web_modules'],
+      },
+    },
+    {
+      name: 'replace',
+      plugin: replace,
+      options: {
+        'process.env.NODE_ENV': JSON.stringify(developmentMode ? 'development' : 'production'),
+      },
+    },
+    {
+      name: 'babel',
+      plugin: babel,
+      options: {
+        babelHelpers: 'bundled',
+        compact: true,
+        presets: [
+          [
+            '@babel/preset-env',
+            {
+              targets: [
+                'last 3 Chrome major versions',
+                'last 3 ChromeAndroid major versions',
+                'last 3 Firefox major versions',
+                'last 3 Edge major versions',
+                'last 3 Safari major versions',
+                'last 3 iOS major versions',
+              ],
+              useBuiltIns: false,
+              shippedProposals: true,
+              modules: false,
+              bugfixes: true,
+            },
+          ],
+        ],
+      },
+    },
+    {
+      name: 'terser',
+      plugin: terser,
+      options: {
+        mangle: {
+          toplevel: true,
+          properties: {
+            regex: /(^_|_$)/,
+          },
+        },
+      },
+    },
+  ];
+
+  return { config, metaPlugins, developmentMode };
+}

packages/building-rollup/src/createSpaConfig.js

@@ -1,6 +1,4 @@
-import path from 'path';
 import { rollupPluginHTML } from '@web/rollup-plugin-html';
-import { generateSW } from 'rollup-plugin-workbox';
 import { importMetaAssets } from '@web/rollup-plugin-import-meta-assets';
 import { polyfillsLoader } from '@web/rollup-plugin-polyfills-loader';
 import { metaConfigToRollupConfig } from 'plugins-manager';
@@ -37,31 +35,6 @@ export function createSpaMetaConfig(userConfig = { output: {} }) {
       options: {
         rootDir,
         absoluteBaseUrl,
-        injectServiceWorker: true,
-        serviceWorkerPath: path.join(config.output.dir, 'service-worker.js'),
-      },
-    },
-    {
-      name: 'workbox',
-      plugin: generateSW,
-      options: {
-        // Keep 'legacy-*.js' just for retro compatibility
-        globIgnores: ['polyfills/*.js', 'legacy-*.js', 'nomodule-*.js'],
-        navigateFallback: '/index.html',
-        // where to output the generated sw
-        swDest: path.join(config.output.dir, 'service-worker.js'),
-        // directory to match patterns against to be precached
-        globDirectory: path.join(config.output.dir),
-        // cache any html js and css by default
-        globPatterns: ['**/*.{html,js,css,webmanifest}'],
-        skipWaiting: true,
-        clientsClaim: true,
-        runtimeCaching: [
-          {
-            urlPattern: 'polyfills/*.js',
-            handler: 'CacheFirst',
-          },
-        ],
       },
     },
     {

packages/building-rollup/test-node/createConfig.test.js

@@ -9,13 +9,13 @@ describe('plugin count', () => {
     expect(config.plugins.length).to.equal(3);
   });
 
-  it('createSpaConfig has 7 plugins', () => {
+  it('createSpaConfig has 6 plugins', () => {
     const config = createSpaConfig();
-    expect(config.plugins.length).to.equal(7);
+    expect(config.plugins.length).to.equal(6);
   });
 
-  it('createMpaConfig has 7 plugins', () => {
+  it('createMpaConfig has 6 plugins', () => {
     const config = createMpaConfig();
-    expect(config.plugins.length).to.equal(7);
+    expect(config.plugins.length).to.equal(6);
   });
 });

packages/building-rollup/test-node/createMpaConfig.test.js

@@ -26,10 +26,7 @@ async function execute(configString) {
   const config = (await import(configPath)).default;
   await buildAndWrite(config);
 
-  return async (
-    fileName,
-    { stripServiceWorker = false, stripToBody = false, stripStartEndWhitespace = true } = {},
-  ) => {
+  return async (fileName, { stripToBody = false, stripStartEndWhitespace = true } = {}) => {
     let text = await fs.promises.readFile(
       path.join(config.output.dir, fileName.split('/').join(path.sep)),
     );
@@ -39,11 +36,6 @@ async function execute(configString) {
       const bodyCloseTagStart = text.indexOf('</body>');
       text = text.substring(bodyOpenTagEnd, bodyCloseTagStart);
     }
-    if (stripServiceWorker) {
-      const scriptOpenTagEnd = text.indexOf('<script inject-service-worker');
-      const scriptCloseTagStart = text.indexOf('</script>', scriptOpenTagEnd) + 9;
-      text = text.substring(0, scriptOpenTagEnd) + text.substring(scriptCloseTagStart);
-    }
     if (stripStartEndWhitespace) {
       text = text.trim();
     }
@@ -57,25 +49,26 @@ describe('createMapConfig', () => {
 
     const indexHtml = await readOutput('index.html', {
       stripToBody: true,
-      stripServiceWorker: true,
     });
-    expect(indexHtml).to.equal('<h1>Only static html content in index.html</h1>');
+    expect(indexHtml).to.equal('<h1>Only static HTML content in index.html</h1>');
 
     const subHtmlIndexHtml = await readOutput('sub-html/index.html', {
       stripToBody: true,
-      stripServiceWorker: true,
     });
-    expect(subHtmlIndexHtml).to.equal('<h1>Only static html content in sub-html/index.html</h1>');
+    expect(subHtmlIndexHtml).to.equal('<h1>Only static HTML content in sub-html/index.html</h1>');
 
     const subJsIndexHtml = await readOutput('sub-js/index.html', {
       stripToBody: true,
-      stripServiceWorker: true,
     });
     expect(subJsIndexHtml).to.equal(
       '<h1>Has js in sub-js/index.html</h1>\n\n\n<script type="module" src="../sub-js.js"></script>',
     );
 
-    const serviceWorkerJs = await readOutput('service-worker.js');
-    expect(serviceWorkerJs).to.include('Promise'); // not empty string might be enough...
+    const subJsAbsoluteIndexHtml = await readOutput('sub-js-absolute/index.html', {
+      stripToBody: true,
+    });
+    expect(subJsAbsoluteIndexHtml).to.equal(
+      '<h1>Has js in sub-js-absolute/index.html</h1>\n\n\n<script type="module" src="../sub-js-absolute.js"></script>',
+    );
   });
 });

packages/building-rollup/test-node/fixtures/mpa/index.html

@@ -1 +1 @@
-<h1>Only static html content in index.html</h1>
+<h1>Only static HTML content in index.html</h1>

packages/building-rollup/test-node/fixtures/mpa/sub-html/index.html

@@ -1 +1 @@
-<h1>Only static html content in sub-html/index.html</h1>
+<h1>Only static HTML content in sub-html/index.html</h1>

packages/building-rollup/test-node/fixtures/mpa/sub-js-absolute/index.html

@@ -0,0 +1,2 @@
+<h1>Has js in sub-js-absolute/index.html</h1>
+<script type="module" src="/sub-js-absolute/sub-js-absolute.js"></script>

packages/check-html-links/CHANGELOG.md

@@ -1,6 +1,71 @@
 # check-html-links
 
+## 0.2.3
+
+### Patch Changes
+
+- 5043429: Ignore `<a href="tel:9999">` links
+- f08f926: Add missing `slash` dependency
+- a0e8edf: Ignore links containing not http schema urls like `sketch://`, `vscode://`, ...
+
+  ```html
+  <a href="sketch://add-library?url=https%3A%2F%2Fmyexample.com%2Fdesign%2Fui-kit.xml"></a>
+  <a href="vscode://file/c:/myProject/package.json:5:10"></a>
+  ```
+
+- 1949b1e: Ignore plain and html encoded mailto links
+
+  ```html
+  <!-- source -->
+  <a href="mailto:address@example.com">contact</a>
+
+  <!-- html encoded -->
+  <a
+    href="&#109;&#97;&#105;&#108;&#116;&#111;&#58;&#97;&#100;&#100;&#114;&#101;&#115;&#115;&#64;&#101;&#120;&#97;&#109;&#112;&#108;&#101;&#46;&#99;&#111;&#109;"
+    >contact</a
+  >
+  ```
+
+## 0.2.2
+
+### Patch Changes
+
+- 66c2d78: fix: windows path issue
+
+## 0.2.1
+
+### Patch Changes
+
+- be0d0b3: fix: add missing main entry to the packages
+
+## 0.2.0
+
+### Minor Changes
+
+- 750418b: Uses a class for the CLI and adding the following options:
+
+  - `--root-dir` the root directory to serve files from. Defaults to the current working directory
+  - `--ignore-link-pattern` do not check links matching the pattern
+  - `--continue-on-error` if present it will not exit with an error code - useful while writing or for temporary passing a ci
+
+  BREAKING CHANGE:
+
+  - Exists with an error code if a broken link is found
+
+## 0.1.2
+
+### Patch Changes
+
+- f343c50: When reading bigger files, especially bigger files with all content on one line it could mean a read chunk is in the middle of a character. This can lead to strange symbols in the resulting string. The `hightWaterMark` is now increased from the node default of 16KB to 256KB. Additionally, the `hightWaterMark` is now synced for reading and parsing.
+
+## 0.1.1
+
+### Patch Changes
+
+- eb74110: Add info about how many files and links will be checked
+
 ## 0.1.0
+
 ### Minor Changes
 
 - cd22231: Initial release

packages/check-html-links/README.md

@@ -1,6 +1,6 @@
-# Check Html Links
+# Check HTML Links
 
-A fast checker for broken links/references in html.
+A fast checker for broken links/references in HTML.
 
 ## Installation
 
@@ -16,9 +16,9 @@ npx check-html-links _site
 
 For docs please see our homepage [https://rocket.modern-web.dev/docs/tools/check-html-links/](https://rocket.modern-web.dev/docs/tools/check-html-links/).
 
-## Comparision
+## Comparison
 
-Checking the output of [11ty-website](https://github.com/11ty/11ty-website) with 13 missing reference targets (used by 516 links) while checking 501 files. (on January 17, 2021)
+Checking the output of the [11ty-website](https://github.com/11ty/11ty-website) with 13 missing reference targets (used by 516 links) while checking 501 files. (on January 17, 2021)
 
 | Tool             | Lines printed | Times  | Lang | Dependency Tree |
 | ---------------- | ------------- | ------ | ---- | --------------- |

packages/check-html-links/index.js

@@ -1,2 +1,3 @@
 export { validateFolder } from './src/validateFolder.js';
 export { formatErrors } from './src/formatErrors.js';
+export { CheckHtmlLinksCli } from './src/CheckHtmlLinksCli.js';

packages/check-html-links/package.json

@@ -1,6 +1,6 @@
 {
   "name": "check-html-links",
-  "version": "0.1.0",
+  "version": "0.2.3",
   "publishConfig": {
     "access": "public"
   },
@@ -13,6 +13,7 @@
   },
   "author": "Modern Web <hello@modern-web.dev> (https://modern-web.dev/)",
   "homepage": "https://rocket.modern-web.dev/docs/tools/check-html-links/",
+  "main": "./index.js",
   "bin": {
     "check-html-links": "src/cli.js"
   },
@@ -33,8 +34,11 @@
   ],
   "dependencies": {
     "chalk": "^4.0.0",
+    "command-line-args": "^5.1.1",
     "glob": "^7.0.0",
-    "sax-wasm": "^2.0.0"
+    "minimatch": "^3.0.4",
+    "sax-wasm": "^2.0.0",
+    "slash": "^3.0.0"
   },
   "devDependencies": {
     "@types/glob": "^7.0.0"

packages/check-html-links/src/CheckHtmlLinksCli.js

@@ -0,0 +1,100 @@
+/* eslint-disable @typescript-eslint/ban-ts-comment */
+
+/** @typedef {import('../types/main').CheckHtmlLinksCliOptions} CheckHtmlLinksCliOptions */
+
+import path from 'path';
+import chalk from 'chalk';
+
+import commandLineArgs from 'command-line-args';
+import { validateFiles } from './validateFolder.js';
+import { formatErrors } from './formatErrors.js';
+import { listFiles } from './listFiles.js';
+
+export class CheckHtmlLinksCli {
+  /** @type {CheckHtmlLinksCliOptions} */
+  options;
+
+  constructor({ argv } = { argv: undefined }) {
+    const mainDefinitions = [
+      { name: 'ignore-link-pattern', type: String, multiple: true },
+      { name: 'root-dir', type: String, defaultOption: true },
+      { name: 'continue-on-error', type: Boolean, defaultOption: false },
+    ];
+    const options = commandLineArgs(mainDefinitions, {
+      stopAtFirstUnknown: true,
+      argv,
+    });
+    this.options = {
+      printOnError: true,
+      continueOnError: options['continue-on-error'],
+      rootDir: options['root-dir'],
+      ignoreLinkPatterns: options['ignore-link-pattern'],
+    };
+  }
+
+  /**
+   * @param {Partial<CheckHtmlLinksCliOptions>} newOptions
+   */
+  setOptions(newOptions) {
+    this.options = {
+      ...this.options,
+      ...newOptions,
+    };
+  }
+
+  async run() {
+    const { ignoreLinkPatterns, rootDir: userRootDir } = this.options;
+    const rootDir = userRootDir ? path.resolve(userRootDir) : process.cwd();
+    const performanceStart = process.hrtime();
+
+    console.log('👀 Checking if all internal links work...');
+    const files = await listFiles('**/*.html', rootDir);
+
+    const filesOutput =
+      files.length == 0
+        ? '🧐 No files to check. Did you select the correct folder?'
+        : `🔥 Found a total of ${chalk.green.bold(files.length)} files to check!`;
+    console.log(filesOutput);
+
+    const { errors, numberLinks } = await validateFiles(files, rootDir, { ignoreLinkPatterns });
+
+    console.log(`🔗 Found a total of ${chalk.green.bold(numberLinks)} links to validate!\n`);
+
+    const performance = process.hrtime(performanceStart);
+    /** @type {string[]} */
+    let output = [];
+    let message = '';
+    if (errors.length > 0) {
+      let referenceCount = 0;
+      for (const error of errors) {
+        referenceCount += error.usage.length;
+      }
+      output = [
+        `❌ Found ${chalk.red.bold(
+          errors.length.toString(),
+        )} missing reference targets (used by ${referenceCount} links) while checking ${
+          files.length
+        } files:`,
+        ...formatErrors(errors)
+          .split('\n')
+          .map(line => `  ${line}`),
+        `Checking links duration: ${performance[0]}s ${performance[1] / 1000000}ms`,
+      ];
+      message = output.join('\n');
+      if (this.options.printOnError === true) {
+        console.error(message);
+      }
+      if (this.options.continueOnError === false) {
+        process.exit(1);
+      }
+    } else {
+      console.log(
+        `✅ All internal links are valid. (executed in ${performance[0]}s ${
+          performance[1] / 1000000
+        }ms)`,
+      );
+    }
+
+    return { errors, message };
+  }
+}

packages/check-html-links/src/cli.js

@@ -1,45 +1,6 @@
 #!/usr/bin/env node
 
-import path from 'path';
-import chalk from 'chalk';
-import { validateFiles } from './validateFolder.js';
-import { formatErrors } from './formatErrors.js';
-import { listFiles } from './listFiles.js';
+import { CheckHtmlLinksCli } from './CheckHtmlLinksCli.js';
 
-async function main() {
-  const userRootDir = process.argv[2];
-  const rootDir = userRootDir ? path.resolve(userRootDir) : process.cwd();
-  const performanceStart = process.hrtime();
-
-  console.log('👀 Checking if all internal links work...');
-  const files = await listFiles('**/*.html', rootDir);
-  const errors = await validateFiles(files, rootDir);
-  const performance = process.hrtime(performanceStart);
-  if (errors.length > 0) {
-    let referenceCount = 0;
-    for (const error of errors) {
-      referenceCount += error.usage.length;
-    }
-    const output = [
-      `❌ Found ${chalk.red.bold(
-        errors.length.toString(),
-      )} missing reference targets (used by ${referenceCount} links) while checking ${
-        files.length
-      } files:`,
-      ...formatErrors(errors)
-        .split('\n')
-        .map(line => `  ${line}`),
-      `Checking links duration: ${performance[0]}s ${performance[1] / 1000000}ms`,
-    ];
-    console.error(output.join('\n'));
-    process.exit(1);
-  } else {
-    console.log(
-      `✅ All internal links are valid. (executed in %ds %dms)`,
-      performance[0],
-      performance[1] / 1000000,
-    );
-  }
-}
-
-main();
+const cli = new CheckHtmlLinksCli();
+cli.run();

packages/check-html-links/src/validateFolder.js

@@ -1,24 +1,29 @@
 /* eslint-disable @typescript-eslint/ban-ts-comment */
 import fs from 'fs';
 import saxWasm from 'sax-wasm';
+import minimatch from 'minimatch';
 import { createRequire } from 'module';
 
 import { listFiles } from './listFiles.js';
 import path from 'path';
+import slash from 'slash';
 
 /** @typedef {import('../types/main').Link} Link */
 /** @typedef {import('../types/main').LocalFile} LocalFile */
 /** @typedef {import('../types/main').Usage} Usage */
 /** @typedef {import('../types/main').Error} Error */
+/** @typedef {import('../types/main').Options} Options */
 /** @typedef {import('sax-wasm').Attribute} Attribute */
 
 const require = createRequire(import.meta.url);
 const { SaxEventType, SAXParser } = saxWasm;
 
+const streamOptions = { highWaterMark: 256 * 1024 };
+
 const saxPath = require.resolve('sax-wasm/lib/sax-wasm.wasm');
 const saxWasmBuffer = fs.readFileSync(saxPath);
-const parserReferences = new SAXParser(SaxEventType.Attribute);
-const parserIds = new SAXParser(SaxEventType.Attribute /*, { highWaterMark: 256 * 1024 } */);
+const parserReferences = new SAXParser(SaxEventType.Attribute, streamOptions);
+const parserIds = new SAXParser(SaxEventType.Attribute, streamOptions);
 
 /** @type {Error[]} */
 let checkLocalFiles = [];
@@ -41,7 +46,7 @@ function extractReferences(htmlFilePath) {
     if (ev === SaxEventType.Attribute) {
       const data = /** @type {Attribute} */ (/** @type {any} */ (_data));
       const attributeName = data.name.toString();
-      const value = data.value.toString();
+      const value = slash(data.value.toString());
       const entry = {
         attribute: attributeName,
         value,
@@ -76,7 +81,7 @@ function extractReferences(htmlFilePath) {
   };
 
   return new Promise(resolve => {
-    const readable = fs.createReadStream(htmlFilePath);
+    const readable = fs.createReadStream(htmlFilePath, streamOptions);
     readable.on('data', chunk => {
       // @ts-expect-error
       parserReferences.write(chunk);
@@ -112,7 +117,7 @@ function idExists(filePath, id) {
   };
 
   return new Promise(resolve => {
-    const readable = fs.createReadStream(filePath);
+    const readable = fs.createReadStream(filePath, streamOptions);
     readable.on('data', chunk => {
       // @ts-expect-error
       parserIds.write(chunk);
@@ -177,14 +182,27 @@ function getValueAndAnchor(inValue) {
   };
 }
 
+/**
+ * @param {string} url
+ * @returns {boolean}
+ */
+function isNonHttpSchema(url) {
+  const found = url.match(/([a-z]+):/);
+  if (found) {
+    return found.length > 0;
+  }
+  return false;
+}
+
 /**
  *
  * @param {Link[]} links
  * @param {object} options
  * @param {string} options.htmlFilePath
  * @param {string} options.rootDir
+ * @param {function(string): boolean} options.ignoreUsage
  */
-async function resolveLinks(links, { htmlFilePath, rootDir }) {
+async function resolveLinks(links, { htmlFilePath, rootDir, ignoreUsage }) {
   for (const hrefObj of links) {
     const { value, anchor } = getValueAndAnchor(hrefObj.value);
 
@@ -199,8 +217,15 @@ async function resolveLinks(links, { htmlFilePath, rootDir }) {
 
     let valueFile = value.endsWith('/') ? path.join(value, 'index.html') : value;
 
-    if (value.includes('mailto:')) {
+    if (ignoreUsage(value)) {
+      // ignore
+    } else if (
+      value.startsWith('mailto:') ||
+      value.startsWith('mailto:') // = "mailto:" but html encoded
+    ) {
       // ignore for now - could add a check to validate if the email address is valid
+    } else if (value.startsWith('tel:')) {
+      // ignore for now - could add a check to validate if the phone number is valid
     } else if (valueFile === '' && anchor !== '') {
       addLocalFile(htmlFilePath, anchor, usageObj);
     } else if (value.startsWith('//') || value.startsWith('http')) {
@@ -211,6 +236,8 @@ async function resolveLinks(links, { htmlFilePath, rootDir }) {
       addLocalFile(filePath, anchor, usageObj);
     } else if (value === '' && anchor === '') {
       // no need to check it
+    } else if (isNonHttpSchema(value)) {
+      // not a schema we handle
     } else {
       const filePath = path.join(path.dirname(htmlFilePath), valueFile);
       addLocalFile(filePath, anchor, usageObj);
@@ -259,29 +286,43 @@ async function validateLocalFiles(checkLocalFiles) {
 /**
  * @param {string[]} files
  * @param {string} rootDir
+ * @param {Options} opts?
  */
-export async function validateFiles(files, rootDir) {
+export async function validateFiles(files, rootDir, opts) {
   await parserReferences.prepareWasm(saxWasmBuffer);
   await parserIds.prepareWasm(saxWasmBuffer);
 
   errors = [];
   checkLocalFiles = [];
   idCache = new Map();
+  let numberLinks = 0;
+
+  const ignoreLinkPatternRegExps = opts
+    ? opts.ignoreLinkPatterns?.map(pattern => minimatch.makeRe(pattern))
+    : null;
+
+  /** @type {function(string): boolean} */
+  const ignoreUsage = ignoreLinkPatternRegExps
+    ? usage => !!ignoreLinkPatternRegExps.find(regExp => usage.match(regExp))
+    : () => false;
+
   for (const htmlFilePath of files) {
     const { links } = await extractReferences(htmlFilePath);
-    await resolveLinks(links, { htmlFilePath, rootDir });
+    numberLinks += links.length;
+    await resolveLinks(links, { htmlFilePath, rootDir, ignoreUsage });
   }
   await validateLocalFiles(checkLocalFiles);
 
-  return errors;
+  return { errors: errors, numberLinks: numberLinks };
 }
 
 /**
  * @param {string} inRootDir
+ * @param {Options} opts?
  */
-export async function validateFolder(inRootDir) {
+export async function validateFolder(inRootDir, opts) {
   const rootDir = path.resolve(inRootDir);
   const files = await listFiles('**/*.html', rootDir);
-  const errors = await validateFiles(files, rootDir);
+  const { errors } = await validateFiles(files, rootDir, opts);
   return errors;
 }

packages/check-html-links/test-node/fixtures/external-link/index.html

@@ -0,0 +1,5 @@
+<!-- ignore known subsystems -->
+<a href="/docs/"></a>
+<a href="/developer/getting-started.html#js"></a>
+<a href="/developer/language-guides/"></a>
+<a href="/developer/javascript.html"></a>

packages/check-html-links/test-node/fixtures/internal-link-ignore/index.html

@@ -0,0 +1,8 @@
+<a href="/absolute/index.html"></a>
+<a href="./relative/index.html"></a>
+<a href="./relative/subfolder/index.html"></a>
+
+<!-- valid -->
+<a href="./page.html"></a>
+<a href=" ./page.html "></a>
+<a href=" /page.html "></a>

packages/check-html-links/test-node/fixtures/mailto/index.html

@@ -1 +1,3 @@
 <a href="mailto:foo@bar.com"></a>
+<!-- encoded mailto links -->
+<a href="&#109;&#97;&#105;&#108;&#116;&#111;&#58;&#97;&#100;&#100;&#114;&#101;&#115;&#115;&#64;&#101;&#120;&#97;&#109;&#112;&#108;&#101;&#46;&#99;&#111;&#109;"></a>

packages/check-html-links/test-node/fixtures/not-http-schema/index.html

@@ -0,0 +1,2 @@
+<a href="sketch://add-library?url=https%3A%2F%2Fmyexample.com%2Fdesign%2Fui-kit.xml"></a>
+<a href="vscode://file/c:/myProject/package.json:5:10"></a>

packages/check-html-links/test-node/fixtures/tel/index.html

@@ -0,0 +1 @@
+<a href="tel:99999"></a>