mirror of
https://github.com/modernweb-dev/rocket.git
synced 2026-03-21 15:54:57 +00:00
Compare commits
1 Commits
@rocket/la
...
fix/checkL
| Author | SHA1 | Date | |
|---|---|---|---|
|
31eca9f63c |
@@ -10,5 +10,3 @@ _site
|
||||
_site-dev
|
||||
__output
|
||||
__output-dev
|
||||
|
||||
docs/_merged*
|
||||
|
||||
@@ -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) repository by hitting the `fork` button on the GitHub page.
|
||||
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.
|
||||
|
||||
Next, clone our repository onto your computer.
|
||||
Next, clone our repository onto your computer with this command (replacing YOUR_USERNAME with your actual GitHub username)
|
||||
|
||||
```sh
|
||||
git clone git@github.com:modernweb-dev/rocket.git
|
||||
```
|
||||
|
||||
Once cloning is complete, change directory to the repository.
|
||||
Once cloning is complete, change directory to the repo.
|
||||
|
||||
```sh
|
||||
cd rocket
|
||||
```
|
||||
|
||||
Now add your fork as a remote (replacing YOUR_USERNAME with your GitHub username).
|
||||
Now add your fork as a remote
|
||||
|
||||
```sh
|
||||
git remote add fork git@github.com:<YOUR_USERNAME>/rocket.git
|
||||
git remote add fork git@github.com:<YOUR_NAME>/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, then 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 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 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)
|
||||
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)
|
||||
|
||||
### 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.
|
||||
|
||||
## Creating a Changeset
|
||||
## Create 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).
|
||||
|
||||
17
README.md
17
README.md
@@ -1,4 +1,4 @@
|
||||
> This project is in its BETA phase
|
||||
> This project is in it's BETA phase
|
||||
|
||||
<p align="center">
|
||||
<img
|
||||
@@ -19,11 +19,6 @@
|
||||
src="https://img.shields.io/badge/twitter-@modern_web_dev-1DA1F3?style=flat-square"
|
||||
alt="Follow @modern_web_dev on Twitter"
|
||||
/></a>
|
||||
<a href="https://open.vscode.dev/modernweb-dev/rocket"
|
||||
><img
|
||||
src="https://open.vscode.dev/badges/open-in-vscode.svg"
|
||||
alt="Open in VS Code"
|
||||
/></a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
@@ -38,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..
|
||||
|
||||
@@ -46,12 +41,12 @@
|
||||
<a href="https://rocket.modern-web.dev/guides/"><strong>Explore the Rocket Guides ▶</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 sprinkle of JavaScript.
|
||||
> Our goal is to provide developers with a meta framework for static websites with a spricle of JavaScript.
|
||||
|
||||
Get a site up and running in no time and focus on the content.
|
||||
You can still tweak every detail of every underlying tool that gets used.
|
||||
You can still tweak every details of every underlying tool that get's used.
|
||||
|
||||
Rocket is part of the [Modern Web Family](https://twitter.com/modern_web_dev).
|
||||
|
||||
@@ -59,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/about/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/discover/slack/) and say hi. 👋
|
||||
|
||||
### Financial Contributors
|
||||
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
*.docs.md
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
layout: layout-404
|
||||
layout: 404.njk
|
||||
permalink: 404.html
|
||||
---
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
<svg id="n" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 16 16"><defs><style>.cls-1{fill:#c12127;}.cls-2{fill:#fff;}</style></defs><title>n</title><path class="cls-1" d="M0,16V0H16V16ZM3,3V13H8V5h3v8h2V3Z"/><path class="cls-2" d="M3,3H13V13H11V5H8v8H3Z"/></svg>
|
||||
|
Before Width: | Height: | Size: 287 B |
@@ -1,3 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
|
||||
<svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" preserveAspectRatio="xMidYMid meet" viewBox="76.58987244897958 44 164.00775510204068 164" width="160.01" height="160"><defs><path d="M237.6 95L187.6 95L187.6 45L237.6 45L237.6 95Z" id="arNRoK435"></path><path d="M182.59 95L132.59 95L132.59 45L182.59 45L182.59 95Z" id="a3H2WU7Px"></path><path d="M127.59 95L77.59 95L77.59 45L127.59 45L127.59 95Z" id="b1DInM56vl"></path><path d="M237.6 150L187.6 150L187.6 100L237.6 100L237.6 150Z" id="a7LFlgQIwu"></path><path d="M182.59 150L132.59 150L132.59 100L182.59 100L182.59 150Z" id="amwLiZcuo"></path><path d="M182.59 205L132.59 205L132.59 155L182.59 155L182.59 205Z" id="f3Peu5RWan"></path><path d="M237.6 205L187.6 205L187.6 155L237.6 155L237.6 205Z" id="a6DXBfqPa"></path><path d="M127.59 205L77.59 205L77.59 155L127.59 155L127.59 205Z" id="c1GWSTH1z7"></path></defs><g><g><use xlink:href="#arNRoK435" opacity="1" fill="#f9ad00" fill-opacity="1"></use></g><g><use xlink:href="#a3H2WU7Px" opacity="1" fill="#f9ad00" fill-opacity="1"></use></g><g><use xlink:href="#b1DInM56vl" opacity="1" fill="#f9ad00" fill-opacity="1"></use></g><g><use xlink:href="#a7LFlgQIwu" opacity="1" fill="#f9ad00" fill-opacity="1"></use></g><g><use xlink:href="#amwLiZcuo" opacity="1" fill="#4e4e4e" fill-opacity="1"></use></g><g><use xlink:href="#f3Peu5RWan" opacity="1" fill="#4e4e4e" fill-opacity="1"></use></g><g><use xlink:href="#a6DXBfqPa" opacity="1" fill="#4e4e4e" fill-opacity="1"></use></g><g><use xlink:href="#c1GWSTH1z7" opacity="1" fill="#4e4e4e" fill-opacity="1"></use></g></g></svg>
|
||||
|
Before Width: | Height: | Size: 1.7 KiB |
@@ -1 +0,0 @@
|
||||
<svg id="Layer_1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 518 518"><style>.st0{fill:#2c8ebb}.st1{fill:#fff}</style><path class="st0" d="M259 0c143 0 259 116 259 259S402 518 259 518 0 402 0 259 116 0 259 0z"/><path class="st1" d="M435.2 337.5c-1.8-14.2-13.8-24-29.2-23.8-23 .3-42.3 12.2-55.1 20.1-5 3.1-9.3 5.4-13 7.1.8-11.6.1-26.8-5.9-43.5-7.3-20-17.1-32.3-24.1-39.4 8.1-11.8 19.2-29 24.4-55.6 4.5-22.7 3.1-58-7.2-77.8-2.1-4-5.6-6.9-10-8.1-1.8-.5-5.2-1.5-11.9.4C293.1 96 289.6 93.8 286.9 92c-5.6-3.6-12.2-4.4-18.4-2.1-8.3 3-15.4 11-22.1 25.2-1 2.1-1.9 4.1-2.7 6.1-12.7.9-32.7 5.5-49.6 23.8-2.1 2.3-6.2 4-10.5 5.6h.1c-8.8 3.1-12.8 10.3-17.7 23.3-6.8 18.2.2 36.1 7.1 47.7-9.4 8.4-21.9 21.8-28.5 37.5-8.2 19.4-9.1 38.4-8.8 48.7-7 7.4-17.8 21.3-19 36.9-1.6 21.8 6.3 36.6 9.8 42 1 1.6 2.1 2.9 3.3 4.2-.4 2.7-.5 5.6.1 8.6 1.3 7 5.7 12.7 12.4 16.3 13.2 7 31.6 10 45.8 2.9 5.1 5.4 14.4 10.6 31.3 10.6h1c4.3 0 58.9-2.9 74.8-6.8 7.1-1.7 12-4.7 15.2-7.4 10.2-3.2 38.4-12.8 65-30 18.8-12.2 25.3-14.8 39.3-18.2 13.6-3.3 22.1-15.7 20.4-29.4zm-23.8 14.7c-16 3.8-24.1 7.3-43.9 20.2-30.9 20-64.7 29.3-64.7 29.3s-2.8 4.2-10.9 6.1c-14 3.4-66.7 6.3-71.5 6.4-12.9.1-20.8-3.3-23-8.6-6.7-16 9.6-23 9.6-23s-3.6-2.2-5.7-4.2c-1.9-1.9-3.9-5.7-4.5-4.3-2.5 6.1-3.8 21-10.5 27.7-9.2 9.3-26.6 6.2-36.9.8-11.3-6 .8-20.1.8-20.1s-6.1 3.6-11-3.8c-4.4-6.8-8.5-18.4-7.4-32.7 1.2-16.3 19.4-32.1 19.4-32.1s-3.2-24.1 7.3-48.8c9.5-22.5 35.1-40.6 35.1-40.6s-21.5-23.8-13.5-45.2c5.2-14 7.3-13.9 9-14.5 6-2.3 11.8-4.8 16.1-9.5 21.5-23.2 48.9-18.8 48.9-18.8s13-39.5 25-31.8c3.7 2.4 17 32 17 32s14.2-8.3 15.8-5.2c8.6 16.7 9.6 48.6 5.8 68-6.4 32-22.4 49.2-28.8 60-1.5 2.5 17.2 10.4 29 43.1 10.9 29.9 1.2 55 2.9 57.8.3.5.4.7.4.7s12.5 1 37.6-14.5c13.4-8.3 29.3-17.6 47.4-17.8 17.5-.3 18.4 20.2 5.2 23.4z"/></svg>
|
||||
|
Before Width: | Height: | Size: 1.7 KiB |
@@ -1,10 +0,0 @@
|
||||
html {
|
||||
--demo-background-color: #eee;
|
||||
--demo-color: #222;
|
||||
}
|
||||
|
||||
html[theme="dark"] body {
|
||||
background: #333;
|
||||
--demo-background-color: #888;
|
||||
--demo-color: #eee;
|
||||
}
|
||||
@@ -1,10 +1,9 @@
|
||||
<link rel="preconnect" href="https://fonts.googleapis.com" crossorigin>
|
||||
|
||||
<link
|
||||
href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@400;700&display=optional"
|
||||
href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@400;700&display=swap"
|
||||
rel="stylesheet"
|
||||
/>
|
||||
<link
|
||||
href="https://fonts.googleapis.com/css2?family=Montserrat:wght@400;700&display=optional"
|
||||
href="https://fonts.googleapis.com/css2?family=Montserrat:wght@400;700&display=swap"
|
||||
rel="stylesheet"
|
||||
/>
|
||||
<meta name="twitter:creator" content="@modern_web_dev" />
|
||||
@@ -1,51 +1,21 @@
|
||||
:not(rocket-navigation):not(:defined) {
|
||||
opacity: 0;
|
||||
}
|
||||
|
||||
rocket-navigation,
|
||||
header {
|
||||
font-family: 'Montserrat', sans-serif;
|
||||
}
|
||||
|
||||
code-tabs[collection="package-managers"] {
|
||||
--code-tabs-icon-height: 18px;
|
||||
}
|
||||
|
||||
.call-to-action {
|
||||
background: var(--button-one) !important;
|
||||
text-shadow: none !important;
|
||||
border-radius: 5px !important;
|
||||
padding-top: 15px !important;
|
||||
padding-bottom: 15px !important;
|
||||
border: none !important;
|
||||
}
|
||||
|
||||
.call-to-action:hover,
|
||||
.call-to-action:focus,
|
||||
.call-to-action:active {
|
||||
background: var(--button-one-hover) !important;
|
||||
}
|
||||
|
||||
.call-to-action:nth-child(2) {
|
||||
background: var(--button-two) !important;
|
||||
}
|
||||
|
||||
.call-to-action:nth-child(2):hover,
|
||||
.call-to-action:nth-child(2):focus,
|
||||
.call-to-action:nth-child(2):active {
|
||||
background: var(--button-two-hover) !important;
|
||||
}
|
||||
|
||||
body[layout^='layout-home'] .markdown-body .call-to-action:nth-of-type(2) {
|
||||
body[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='layout-home-background'] .page-background {
|
||||
body[layout='home'][home-layout='background'] .page-background {
|
||||
top: -210px;
|
||||
right: -463px;
|
||||
transform: rotate(45deg);
|
||||
}
|
||||
}
|
||||
|
||||
rocket-navigation {
|
||||
font-family: 'Montserrat', sans-serif;
|
||||
}
|
||||
|
||||
header {
|
||||
font-family: 'Montserrat', sans-serif;
|
||||
}
|
||||
|
||||
@@ -1,135 +0,0 @@
|
||||
html {
|
||||
--button-one-hover: #436eff;
|
||||
--button-one: #2758ff;
|
||||
--button-two-hover: #444;
|
||||
--button-two: black;
|
||||
--contrast-color-dark: #1d3557;
|
||||
--contrast-color-light: #fff;
|
||||
--footer-background: rgba(0, 0, 0, 0.02);
|
||||
--header-color: white;
|
||||
--markdown-link-color: #2758ff;
|
||||
--markdown-syntax-background-color: #f9f9f9;
|
||||
--markdown-table-row-odd-background-color: #efefef;
|
||||
--owc-active-color: #2758ff;
|
||||
--owc-hover-color: #436eff;
|
||||
--page-background: white;
|
||||
--primary-color-accent: #cee5f6;
|
||||
--primary-color-darker: #1a5285;
|
||||
--primary-color-lighter: #449ad7;
|
||||
--primary-color: rgb(44, 62, 80);
|
||||
--primary-lines-color: #ccc;
|
||||
--primary-text-color: #2c3e50;
|
||||
}
|
||||
|
||||
@media (prefers-color-scheme: dark) {
|
||||
html {
|
||||
--header-color: #2f3136;
|
||||
--footer-background: rgba(255, 255, 255, 0.1);
|
||||
--page-background: #36393e;
|
||||
--text-color: #eee;
|
||||
--primary-text-color: #eee;
|
||||
--primary-color: white;
|
||||
--primary-color-lighter: #449ad7;
|
||||
--primary-color-darker: #1a5285;
|
||||
--primary-color-accent: #cee5f6;
|
||||
--contrast-color-light: #fff;
|
||||
--contrast-color-dark: #1d3557;
|
||||
--primary-lines-color: #333;
|
||||
--owc-active-color: #41ffb0;
|
||||
--owc-hover-color: #6dffc2;
|
||||
--button-one: #9b03fe;
|
||||
--button-one-hover: #a724ff;
|
||||
--button-two: black;
|
||||
--button-two-hover: rgb(36, 36, 36);
|
||||
--rocket-search-background-color: #4a4d52;
|
||||
--rocket-search-highlight-color: #41ffb0;
|
||||
--rocket-search-hover-background-color: #6b717a;
|
||||
--rocket-search-fill-color: #fff;
|
||||
|
||||
/* Markdown */
|
||||
--markdown-octicon-link: var(--primary-text-color);
|
||||
--markdown-link-color: #41ffb0;
|
||||
--markdown-divider-color: #e1e4e8;
|
||||
--markdown-blockquote-border-color: #dfe2e5;
|
||||
--markdown-blockquote-color: #90aac7;
|
||||
--markdown-kbd-background-color: #fafbfc;
|
||||
--markdown-kbd-border-color: #c6cbd1;
|
||||
--markdown-kbd-border-bottom-color: #959da5;
|
||||
--markdown-kbd-color: #444d56;
|
||||
--markdown-heading-color-6: #6a737d;
|
||||
--markdown-table-background-color: var(--markdown-syntax-background-color);
|
||||
--markdown-table-row-odd-background-color: var(--markdown-kbd-color);
|
||||
--markdown-table-border-color: transparent;
|
||||
--markdown-code-background-color: rgba(27, 31, 35, 0.05);
|
||||
--markdown-pre-background-color: rgb(49, 49, 49);
|
||||
|
||||
/* syntax */
|
||||
--markdown-syntax-color: #f8f8f2;
|
||||
--markdown-syntax-background-color: #2e3440;
|
||||
--markdown-syntax-atrule-color: #88c0d0;
|
||||
--markdown-syntax-attr-name-color: #a3be8c;
|
||||
--markdown-syntax-attr-value-color: #88c0d0;
|
||||
--markdown-syntax-builtin-color: #a3be8c;
|
||||
--markdown-syntax-boolean-color: #81a1c1;
|
||||
--markdown-syntax-class-name-color: #88c0d0;
|
||||
--markdown-syntax-constant-color: #81a1c1;
|
||||
--markdown-syntax-char-color: #a3be8c;
|
||||
--markdown-syntax-deleted-color: #81a1c1;
|
||||
--markdown-syntax-entity-color: #81a1c1;
|
||||
--markdown-syntax-function-color: #88c0d0;
|
||||
--markdown-syntax-inserted-color: #a3be8c;
|
||||
--markdown-syntax-keyword-color: #81a1c1;
|
||||
--markdown-syntax-number-color: #b48ead;
|
||||
--markdown-syntax-operator-color: #81a1c1;
|
||||
--markdown-syntax-property-color: #81a1c1;
|
||||
--markdown-syntax-punctuation-color: #81a1c1;
|
||||
--markdown-syntax-regex-color: #81a1c1;
|
||||
--markdown-syntax-important-color: #81a1c1;
|
||||
--markdown-syntax-selector-color: #a3be8c;
|
||||
--markdown-syntax-symbol-color: #81a1c1;
|
||||
--markdown-syntax-string-color: #a3be8c;
|
||||
--markdown-syntax-tag-color: #81a1c1;
|
||||
--markdown-syntax-url-color: #81a1c1;
|
||||
--markdown-syntax-variable-color: #81a1c1;
|
||||
--markdown-syntax-hotkey-selector-color: #d73a49;
|
||||
--markdown-syntax-keyword-color: #22863a;
|
||||
--markdown-syntax-background-color: rgb(27, 29, 35);
|
||||
--markdown-syntax-atrule-color: rgb(198, 120, 221);
|
||||
--markdown-syntax-attr-name-color: rgb(198, 120, 221);
|
||||
--markdown-syntax-boolean-color: rgb(209, 154, 102);
|
||||
--markdown-syntax-class-name-color: rgb(97, 175, 239);
|
||||
--markdown-syntax-constant-color: rgb(220, 220, 170);
|
||||
--markdown-syntax-entity-color: rgb(220, 220, 170);
|
||||
--markdown-syntax-function-color: rgb(97, 175, 239);
|
||||
--markdown-syntax-inserted-color: rgb(220, 220, 170);
|
||||
--markdown-syntax-keyword-color: rgb(198, 120, 221);
|
||||
--markdown-syntax-number-color: rgb(220, 220, 170);
|
||||
--markdown-syntax-operator-color: rgb(220, 220, 170);
|
||||
--markdown-syntax-property-color: rgb(220, 220, 170);
|
||||
--markdown-syntax-punctuation-color: white;
|
||||
--markdown-syntax-regex-color: rgb(209, 154, 102);
|
||||
--markdown-syntax-selector-color: rgb(86, 156, 214);
|
||||
--markdown-syntax-symbol-color: rgb(220, 220, 170);
|
||||
--markdown-syntax-tag-color: rgb(86, 156, 214);
|
||||
--markdown-syntax-url-color: rgb(220, 220, 170);
|
||||
--markdown-syntax-variable-color: rgb(220, 220, 170);
|
||||
}
|
||||
|
||||
.string {
|
||||
color: rgb(152, 195, 121);
|
||||
}
|
||||
|
||||
.comment {
|
||||
color: #7d7d7d;
|
||||
}
|
||||
|
||||
.language-css {
|
||||
--markdown-syntax-string-color: #81a1c1;
|
||||
}
|
||||
}
|
||||
|
||||
body[layout='home'] .markdown-body .call-to-action:nth-of-type(2) {
|
||||
--primary-color: #222;
|
||||
--primary-color-lighter: #333;
|
||||
--primary-color-darker: #000;
|
||||
}
|
||||
@@ -16,7 +16,7 @@
|
||||
"name": "Follow",
|
||||
"children": [
|
||||
{
|
||||
"text": "GitHub",
|
||||
"text": "Github",
|
||||
"href": "https://github.com/modernweb-dev/rocket"
|
||||
},
|
||||
{
|
||||
|
||||
@@ -3,17 +3,12 @@ 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',
|
||||
url: 'https://github.com/modernweb-dev/rocket',
|
||||
},
|
||||
{
|
||||
name: 'Slack',
|
||||
url:
|
||||
'https://join.slack.com/t/lit-and-friends/shared_invite/zt-llwznvsy-LZwT13R66gOgnrg12PUGqw',
|
||||
},
|
||||
],
|
||||
gitSiteUrl: 'https://github.com/modernweb-dev/rocket',
|
||||
gitBranch: 'main',
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
<link rel="stylesheet" href="{{ '/_assets/theme.css' | asset | url }}">
|
||||
@@ -1,3 +0,0 @@
|
||||
<meta name="twitter:creator" content="@modern_web_dev" />
|
||||
|
||||
<link rel="stylesheet" href="{{ '/_assets/body.css' | asset | url }}" mdjs-use>
|
||||
@@ -1,5 +1,5 @@
|
||||
# Slack
|
||||
|
||||
You can also find us on the Polymer Slack in the [#open-wc](https://polymer.slack.com/archives/CE6D9DN05) channel.
|
||||
You can also find us on the Polymer slack in the [#open-wc](https://slack.com/share/IUQNUPWUF/awabyN8iYH4dXX6aGpu16ES9/enQtOTc2Nzc2ODEyOTY3LWM5ZGExNGFiMmM4NDY2YWI2MzYwOGY5ZTNlZjk4OGU4NTFhMGJjNmVhNGI4MzVlNTMwNGRiNGIxNjc4MGJhNDg) channel.
|
||||
|
||||
You can join the Polymer Slack by visiting [https://www.polymer-project.org/slack-invite](https://www.polymer-project.org/slack-invite).
|
||||
You can join the Polymer slack by visiting https://www.polymer-project.org/slack-invite.
|
||||
|
||||
@@ -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 us know](mailto:hello@modern-web.dev).
|
||||
If you are interested in monetary sponsoring please [let as know as](mailto:hello@modern-web.dev).
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
layout: layout-blog-overview
|
||||
title: Rocket Blog
|
||||
layout: blog
|
||||
eleventyNavigation:
|
||||
key: Blog
|
||||
order: 30
|
||||
@@ -10,6 +11,4 @@ pagination:
|
||||
alias: posts
|
||||
---
|
||||
|
||||
# Rocket Blog
|
||||
|
||||
Discover articles from the core team and contributors about Rocket, tips and tricks included!
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Introducing Check HTMl Links - no more bad links
|
||||
title: Introducing check html links - no more bad links
|
||||
published: true
|
||||
description: A fast link checker for static HTML
|
||||
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
|
||||
---
|
||||
@@ -15,17 +15,17 @@ It's really hard to catch especially if you have a dynamic page like with WordPr
|
||||
|
||||
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
|
||||
## 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, ...
|
||||
However, when checking existing solutions I found out that most of them didn't satisfy me in at least on 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
|
||||
- Preferably in the NodeJS ecosystem
|
||||
|
||||
## Focusing on Useful Output
|
||||
|
||||
@@ -81,7 +81,7 @@ Let us turn that around and focus on missing references indeed. Here is the outp
|
||||
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
|
||||
### 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.
|
||||
|
||||
@@ -113,14 +113,14 @@ Results are gatherd on January 26, 2021:
|
||||
| web.dev | 830 | ~3.7s |
|
||||
| eslint.org | 3475 | ~12.4s |
|
||||
|
||||
## Being Part of the Node.js Ecosystem
|
||||
## Being part of the NodeJS 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.
|
||||
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 NodeJS. Having it standalone (usable via `npx`) also makes it more versatile and easier to maintain/test.
|
||||
|
||||
## Focusing on a Small Dependency Tree
|
||||
## 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 👑.
|
||||
The JavaScript and NodeJs 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
|
||||
|
||||
@@ -130,23 +130,23 @@ 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
|
||||
- extracts every attribute value of id, href, src, srset
|
||||
- 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.
|
||||
It does check your final html output so you need to execute it after your Static Site Generator.
|
||||
|
||||
```
|
||||
npx check-html-links _site
|
||||
```
|
||||
|
||||
## GitHub Action Usage
|
||||
## Usage Github Action
|
||||
|
||||
[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).
|
||||
[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:
|
||||
|
||||
@@ -168,7 +168,7 @@ jobs:
|
||||
|
||||
## 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)
|
||||
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)
|
||||
|
||||
| Tool | Lines printed | Duration | Lang | Dependency Tree |
|
||||
| ---------------- | ------------- | -------- | ---- | --------------- |
|
||||
@@ -193,13 +193,13 @@ Topic to work on:
|
||||
|
||||
## 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).
|
||||
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).
|
||||
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).
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,40 +0,0 @@
|
||||
# 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.js` (or your theme config file)
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
```js copy
|
||||
import { addPlugin } from 'plugins-manager';
|
||||
|
||||
/** @type {import('@rocket/cli').RocketCliOptions} */
|
||||
export default ({
|
||||
setupEleventyComputedConfig: [
|
||||
addPlugin({ name: 'greeting', plugin: data => `Welcome to the ${data.title} page.` }),
|
||||
],
|
||||
});
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
Now you can use {% raw %}{{ greeting }}{% endraw %} everywhere,
|
||||
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 },
|
||||
];
|
||||
```
|
||||
@@ -1,314 +0,0 @@
|
||||
# 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
|
||||
|
||||
```
|
||||
|
||||
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
|
||||
|
||||
```
|
||||
|
||||
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`
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
```js
|
||||
/** @type {import('rocket/cli').RocketCliConfig} */
|
||||
export default ({
|
||||
imagePresets: {
|
||||
responsive: {
|
||||
widths: [300, 820],
|
||||
formats: ['avif', 'jpeg'],
|
||||
sizes: '(min-width: 1024px) 820px, calc(100vw - 20px)',
|
||||
},
|
||||
},
|
||||
});
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
## Ignoring Images
|
||||
|
||||
Files ending in `.svg` or that include `rocket-ignore.` will remain untouched.
|
||||
|
||||
For example
|
||||
|
||||
```md
|
||||
|
||||
|
||||
|
||||
```
|
||||
|
||||
becomes
|
||||
|
||||
```html
|
||||
<img src="logo.svg" alt="Logo stays svg" rocket-image="responsive" />
|
||||
<img src="my-image.rocket-unresponsive.jpg" alt="Ignore by file name" rocket-image="responsive" />
|
||||
<picture>[...] </picture>
|
||||
```
|
||||
|
||||
### Adjusting ignore function
|
||||
|
||||
The default ignore function looks like this
|
||||
|
||||
```js
|
||||
/**
|
||||
* The default responsive ignore function will ignore files
|
||||
* - ending in `.svg`
|
||||
* - containing `rocket-unresponsive.`
|
||||
*
|
||||
* @param {object} opts
|
||||
* @param {string} opts.src
|
||||
* @param {string} opts.title
|
||||
* @param {string} opts.alt
|
||||
* @param {{name: string, value: string}[]} opts.attributes
|
||||
* @returns {boolean}
|
||||
*/
|
||||
function ignore({ src }) {
|
||||
return src.endsWith('svg') || src.includes('rocket-unresponsive.');
|
||||
}
|
||||
```
|
||||
|
||||
and you can adjust it by setting it via the `imagePreset`.
|
||||
|
||||
For this example we want to also ignore `.jpeg` files.
|
||||
|
||||
👉 `rocket.config.js`
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
```js
|
||||
/** @type {import('rocket/cli').RocketCliConfig} */
|
||||
export default ({
|
||||
imagePresets: {
|
||||
responsive: {
|
||||
// ...
|
||||
ignore: ({ src }) =>
|
||||
src.endsWith('.jpeg') || src.endsWith('svg') || src.includes('rocket-unresponsive.'),
|
||||
},
|
||||
},
|
||||
});
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
With that setting we get the following behavior
|
||||
|
||||
```md
|
||||
|
||||
|
||||
|
||||
```
|
||||
|
||||
becomes
|
||||
|
||||
```html
|
||||
<img src="logo.svg" alt="Logo stays svg" rocket-image="responsive" />
|
||||
<img src="my-image.rocket-unresponsive.jpg" alt="Ignore by file name" rocket-image="responsive" />
|
||||
<img src="my-image.jpeg" alt="My Image Alternative Text" rocket-image="responsive" />
|
||||
```
|
||||
|
||||
## Defining your own presets
|
||||
|
||||
You can add your own image preset like so
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
```js
|
||||
/** @type {import('rocket/cli').RocketCliConfig} */
|
||||
export default ({
|
||||
imagePresets: {
|
||||
'my-image-preset': {
|
||||
widths: [30, 60],
|
||||
formats: ['avif', 'jpeg'],
|
||||
sizes: '(min-width: 1024px) 30px, 60px',
|
||||
},
|
||||
},
|
||||
});
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
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 `` 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`
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
```js
|
||||
/** @type {import('rocket/cli').RocketCliConfig} */
|
||||
export default ({
|
||||
imagePresets: {
|
||||
responsive: {
|
||||
formats: ['avif', 'webp', 'jpeg'],
|
||||
},
|
||||
},
|
||||
});
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
## 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`
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
```js
|
||||
/** @type {import('rocket/cli').RocketCliConfig} */
|
||||
export default ({
|
||||
imagePresets: {
|
||||
responsive: {
|
||||
widths: [300, 600, 900, 1200, 1640],
|
||||
sizes: '(min-width: 1024px) 820px, calc(100vw - 20px)',
|
||||
},
|
||||
},
|
||||
});
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
<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';
|
||||
```
|
||||
@@ -1,53 +1,47 @@
|
||||
# Configuration >> Overview || 10
|
||||
# Configuration >> Overview ||10
|
||||
|
||||
The configuration file is `rocket.config.js` or `rocket.config.mjs`.
|
||||
|
||||
The config files consist of the following parts:
|
||||
The config files consists of the following parts:
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
```js
|
||||
import { rocketLaunch } from '@rocket/launch';
|
||||
|
||||
/** @type {import('rocket/cli').RocketCliConfig} */
|
||||
export default ({
|
||||
export default {
|
||||
presets: [rocketLaunch()],
|
||||
emptyOutputDir: true,
|
||||
pathPrefix: 'subfolder-only-for-build',
|
||||
});
|
||||
};
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
Rocket is primarily build around plugins for each of its systems.
|
||||
Rocket is primarily build around plugins for each of it's systems.
|
||||
|
||||
New plugins can be added and all default plugins can be adjusted or even removed by using the following functions.
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
```js
|
||||
/** @type {import('rocket/cli').RocketCliConfig} */
|
||||
export default ({
|
||||
// add remark/unified plugin to the Markdown processing (e.g. enable special code blocks)
|
||||
export default {
|
||||
// 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)
|
||||
// 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: [],
|
||||
});
|
||||
};
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
## Adding Rollup Plugins
|
||||
|
||||
@@ -57,53 +51,38 @@ 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:
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
```js
|
||||
import json from '@rollup/plugin-json';
|
||||
import { addPlugin } from 'plugins-manager';
|
||||
|
||||
/** @type {import('@rocket/cli').RocketCliOptions} */
|
||||
export default ({
|
||||
/** @type {Partial<import("@rocket/cli").RocketCliOptions>} */
|
||||
const config = {
|
||||
setupDevAndBuildPlugins: [
|
||||
addPlugin({ name: 'json', plugin: json, location: 'top', options: { my: 'settings' } }),
|
||||
],
|
||||
});
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
};
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Modifying Options of Plugins
|
||||
|
||||
All plugins which are either default or are added via a preset can still be adjusted by using `adjustPluginOptions`.
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
```js
|
||||
import { adjustPluginOptions } from 'plugins-manager';
|
||||
|
||||
/** @type {import('@rocket/cli').RocketCliOptions} */
|
||||
export default ({
|
||||
/** @type {Partial<import("@rocket/cli").RocketCliOptions>} */
|
||||
const config = {
|
||||
setupDevAndBuildPlugins: [adjustPluginOptions('json', { my: 'overwrite settings' })],
|
||||
});
|
||||
};
|
||||
|
||||
export default config;
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
## Lifecycle
|
||||
|
||||
You can hook into the rocket lifecycle by specifying a function for `before11ty`. This function runs before 11ty calls it's write method. If it is an async function, Rocket will await it's promise.
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
```js
|
||||
/** @type {import('rocket/cli').RocketCliConfig} */
|
||||
export default ({
|
||||
async before11ty() {
|
||||
await copyDataFiles();
|
||||
},
|
||||
});
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
@@ -1,48 +0,0 @@
|
||||
# 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`
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
```js
|
||||
/** @type {import('rocket/cli').RocketCliConfig} */
|
||||
export default ({
|
||||
serviceWorkerName: 'my-service-worker-name.js',
|
||||
});
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
## 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 -->
|
||||
41
docs/docs/configuration/setupEleventyComputedConfig.md
Normal file
41
docs/docs/configuration/setupEleventyComputedConfig.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# Configuration >> setupEleventyComputedConfig ||20
|
||||
|
||||
If you want to add data that depends on other data then you can do it via [11ty'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` everyhwere. (a filter might be a better choise 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 everywhere {{ greeting }}.
|
||||
{% endraw %}
|
||||
And it will 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 },
|
||||
];
|
||||
```
|
||||
@@ -1,6 +1,6 @@
|
||||
# Eleventy Plugins >> Markdown JavaScript (mdjs)
|
||||
# Eleventy Plugins >> Markdown JavaScript (Mdjs)
|
||||
|
||||
Use mdjs in your Eleventy site.
|
||||
Use mdjs in your 11ty site.
|
||||
|
||||
## Setup
|
||||
|
||||
@@ -8,7 +8,7 @@ Use mdjs in your Eleventy site.
|
||||
npm install @rocket/eleventy-plugin-mdjs
|
||||
```
|
||||
|
||||
Create an Eleventy config file `.eleventy.js`
|
||||
Create an 11ty 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');
|
||||
|
||||
@@ -7,25 +7,6 @@ eleventyNavigation:
|
||||
|
||||
Here you will find all the details for each of the packages/systems we offer.
|
||||
|
||||
## Contents
|
||||
You should check out:
|
||||
|
||||
- [Configuration](./configuration/)
|
||||
- [Overview](./configuration/overview/)
|
||||
- [Computed Config](./configuration/computed-config/)
|
||||
- [Service Worker](./configuration/service-worker/)
|
||||
- [Images](./configuration/images/)
|
||||
- [Presets](./presets/)
|
||||
- [Joining Blocks](./presets/joining-blocks/)
|
||||
- [`@rocket/launch`](./presets/launch/)
|
||||
- [`@rocket/search`](./presets/search/)
|
||||
- [`@rocket/blog`](./presets/blog/)
|
||||
- [Markdown JavaScript](./markdown-javascript/)
|
||||
- [Overview](./markdown-javascript/overview/)
|
||||
- [Preview](./markdown-javascript/preview/)
|
||||
- [Story](./markdown-javascript/story/)
|
||||
- [Eleventy Plugins](./eleventy-plugins/)
|
||||
- [Markdown JavaScript (mdjs)](./eleventy-plugins/mdjs-unified/)
|
||||
- [Tools](./tools/)
|
||||
- [Plugins Manager](./tools/plugins-manager/)
|
||||
- [Rollup Config](./tools/rollup-config/)
|
||||
- [Check HTML Links ](./tools/check-html-links/)
|
||||
- [@rocket/launch](./presets/launch.md) which is our default preset
|
||||
|
||||
@@ -1,69 +0,0 @@
|
||||
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);
|
||||
@@ -1,12 +1,6 @@
|
||||
# Markdown JavaScript >> Overview || 10
|
||||
|
||||
```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.
|
||||
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`.
|
||||
|
||||
@@ -19,9 +13,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
|
||||
@@ -58,18 +52,27 @@ customElements.define('my-el', MyEl);
|
||||
|
||||
## Demo Support (Story)
|
||||
|
||||
mdjs comes with some additional helpers you can choose to import:
|
||||
mdjs comes with some additional helpers you can choose to import via
|
||||
|
||||
````md
|
||||
```js script
|
||||
import '@mdjs/mdjs-story/define';
|
||||
import '@mdjs/mdjs-preview/define';
|
||||
import '@mdjs/mdjs-story/mdjs-story.js';
|
||||
import '@mdjs/mdjs-preview/mdjs-preview.js';
|
||||
```
|
||||
````
|
||||
|
||||
Once loaded you can use them like so:
|
||||
once loaded you can use them like so.
|
||||
|
||||
### Story
|
||||
````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
|
||||
|
||||
The code snippet will actually get executed at that place and you will have a live demo
|
||||
|
||||
@@ -85,7 +88,7 @@ export const JsStory = () => html` <demo-wc-card>JS Story</demo-wc-card> `;
|
||||
```
|
||||
````
|
||||
|
||||
#### Full Code Support
|
||||
#### full code support
|
||||
|
||||
````md
|
||||
```js story
|
||||
@@ -98,7 +101,7 @@ export const JsStory = () => {
|
||||
```
|
||||
````
|
||||
|
||||
### Preview Story
|
||||
### preview story
|
||||
|
||||
Will become a live demo wrapped in a container with a show code button.
|
||||
|
||||
@@ -116,6 +119,12 @@ 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 = () => {
|
||||
@@ -125,15 +134,40 @@ 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 pages, Markdown files, issues, pull requests...
|
||||
See live demos directly inside github page, markdown files, issues, pull requests...
|
||||
|
||||
Please check out [mdjs-viewer](https://github.com/open-wc/mdjs-viewer).
|
||||
|
||||
@@ -145,7 +179,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');
|
||||
@@ -163,7 +197,7 @@ const page = await mdjsDocPage(markdownString);
|
||||
|
||||
#### `mdjsProcess`
|
||||
|
||||
Pass in multiple Markdown documents and you get back all the JavaScript code and rendered HTML.
|
||||
Pass in multiple markdown documents and you get back all the jsCode and rendered html.
|
||||
|
||||
```js
|
||||
const { mdjsProcess } = require('@mdjs/core');
|
||||
|
||||
@@ -2,168 +2,18 @@
|
||||
|
||||
You can showcase live running code by annotating a code block with `js preview-story`.
|
||||
|
||||
## Features
|
||||
|
||||
- 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>`;
|
||||
import { html } from 'lit-html';
|
||||
|
||||
export const foo = () => html` <p>my html</p> `;
|
||||
```
|
||||
````
|
||||
|
||||
will result in
|
||||
|
||||
```js preview-story
|
||||
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`.
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
```js
|
||||
/** @type {import('rocket/cli').RocketCliConfig} */
|
||||
export default ({
|
||||
setupUnifiedPlugins: [
|
||||
adjustPluginOptions('mdjsSetupCode', {
|
||||
simulationSettings: { simulatorUrl: '/simulator/' },
|
||||
}),
|
||||
],
|
||||
});
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
<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';
|
||||
import { html } from 'lit-html';
|
||||
|
||||
export const foo = () => html` <p>my html</p> `;
|
||||
```
|
||||
|
||||
@@ -2,16 +2,10 @@
|
||||
|
||||
You can showcase live running code by annotating a code block with `js story`.
|
||||
|
||||
```js script
|
||||
import { html } from '@mdjs/mdjs-story';
|
||||
```
|
||||
|
||||
````md
|
||||
```js script
|
||||
import { html } from '@mdjs/mdjs-story';
|
||||
```
|
||||
|
||||
```js story
|
||||
import { html } from 'lit-html';
|
||||
|
||||
export const foo = () => html` <p>my html</p> `;
|
||||
```
|
||||
````
|
||||
@@ -19,5 +13,7 @@ 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> `;
|
||||
```
|
||||
|
||||
@@ -1,36 +1,21 @@
|
||||
# Presets >> Blog || 40
|
||||
# Presets >> Blog ||30
|
||||
|
||||
Enable writing blog posts within your Rocket site.
|
||||
Enable writing blog posts within your rocket site
|
||||
|
||||
## Installation
|
||||
|
||||
<code-tabs collection="package-managers" default-tab="npm" align="end">
|
||||
|
||||
```bash tab npm
|
||||
```bash
|
||||
npm i @rocket/blog
|
||||
```
|
||||
|
||||
```bash tab yarn
|
||||
yarn add @rocket/blog
|
||||
```
|
||||
|
||||
```bash tab pnpm
|
||||
pnpm add @rocket/blog
|
||||
```
|
||||
|
||||
</code-tabs>
|
||||
|
||||
## Usage
|
||||
|
||||
👉 `rocket.config.js`
|
||||
👉 `rocket.config.mjs`
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
```js
|
||||
import { rocketBlog } from '@rocket/blog';
|
||||
|
||||
/** @type {import('rocket/cli').RocketCliConfig} */
|
||||
export default ({
|
||||
export default {
|
||||
presets: [rocketBlog()],
|
||||
});
|
||||
};
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
@@ -1,102 +0,0 @@
|
||||
# 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 %}
|
||||
|
||||
```jinja2
|
||||
<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
|
||||
|
||||
👉 `_includes/_joiningBlocks/footer/10-first.njk`
|
||||
|
||||
```html
|
||||
<p>first</p>
|
||||
```
|
||||
|
||||
👉 `_includes/_joiningBlocks/footer/20-second.njk`
|
||||
|
||||
```html
|
||||
<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.
|
||||
|
||||
👉 `docs/_includes/_joiningBlocks/footer/15-in-between.njk`
|
||||
|
||||
```html
|
||||
<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.
|
||||
|
||||
👉 `docs/_includes/_joiningBlocks/footer/10-first.njk`
|
||||
|
||||
```html
|
||||
<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
|
||||
|
||||
👉 `docs/_includes/_joiningBlocks/footer/30-first.njk`
|
||||
|
||||
```html
|
||||
<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.
|
||||
119
docs/docs/presets/launch.md
Normal file
119
docs/docs/presets/launch.md
Normal file
@@ -0,0 +1,119 @@
|
||||
# Presets >> Launch ||10
|
||||
|
||||
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
|
||||
|
||||
```bash
|
||||
npm i @rocket/launch
|
||||
```
|
||||
|
||||
👉 `rocket.config.mjs`
|
||||
|
||||
```js
|
||||
import { rocketLaunch } from '@rocket/launch';
|
||||
|
||||
export default {
|
||||
presets: [rocketLaunch()],
|
||||
};
|
||||
```
|
||||
|
||||
## Data
|
||||
|
||||
Most data comes from `site.cjs`.
|
||||
|
||||
There is also a specific `rocketLaunch.json`.
|
||||
|
||||
The footer data comes from `footer.json`
|
||||
|
||||
## Inline Notification
|
||||
|
||||
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.
|
||||
|
||||
```js script
|
||||
import '@rocket/launch/inline-notification/inline-notification.js';
|
||||
```
|
||||
|
||||
First you need to import the script
|
||||
|
||||
````
|
||||
```js script
|
||||
import '@rocket/launch/inline-notification/inline-notification.js';
|
||||
```
|
||||
````
|
||||
|
||||
### Tip
|
||||
|
||||
<inline-notification type="tip">
|
||||
|
||||
I am a tip
|
||||
|
||||
</inline-notification>
|
||||
|
||||
**Usage**
|
||||
|
||||
```md
|
||||
<inline-notification type="tip">
|
||||
|
||||
I am a tip
|
||||
|
||||
</inline-notification>
|
||||
```
|
||||
|
||||
### Modify the title
|
||||
|
||||
To override the title you can provide a property success.
|
||||
|
||||
<inline-notification type="tip" title="success">
|
||||
|
||||
I am a success message
|
||||
|
||||
</inline-notification>
|
||||
|
||||
**Usage**
|
||||
|
||||
```md
|
||||
<inline-notification type="tip" title="success">
|
||||
|
||||
I am a success message
|
||||
|
||||
</inline-notification>
|
||||
```
|
||||
|
||||
### Warning
|
||||
|
||||
<inline-notification type="warning">
|
||||
|
||||
I am a warning
|
||||
|
||||
</inline-notification>
|
||||
|
||||
**Usage**
|
||||
|
||||
```md
|
||||
<inline-notification type="warning">
|
||||
|
||||
I am a warning
|
||||
|
||||
</inline-notification>
|
||||
```
|
||||
|
||||
### Danger
|
||||
|
||||
<inline-notification type="danger">
|
||||
|
||||
I am a dangerous message
|
||||
|
||||
</inline-notification>
|
||||
|
||||
**Usage**
|
||||
|
||||
```md
|
||||
<inline-notification type="danger">
|
||||
|
||||
I am a dangerous message
|
||||
|
||||
</inline-notification>
|
||||
```
|
||||
@@ -1,7 +0,0 @@
|
||||
---
|
||||
layout: layout-api
|
||||
package: '@rocket/launch'
|
||||
module: inline-notification/index.js
|
||||
---
|
||||
|
||||
# Presets >> Launch >> Custom Elements || 20
|
||||
@@ -1,4 +0,0 @@
|
||||
# Presets >> Launch || 20
|
||||
|
||||
- [Preset](./preset/)
|
||||
- [Custom Elements](./custom-elements/)
|
||||
@@ -1,145 +0,0 @@
|
||||
---
|
||||
alerts:
|
||||
- type: tip
|
||||
content: Take a tip from me
|
||||
- type: warning
|
||||
content: Be *sure* about this...
|
||||
- type: danger
|
||||
content: You **really** shouldn't!
|
||||
---
|
||||
|
||||
# Presets >> Launch >> Preset || 10
|
||||
|
||||
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
|
||||
|
||||
Install `@rocket/launch` from the NPM repository using your favourite package manager.
|
||||
|
||||
<code-tabs collection="package-managers" default-tab="npm" align="end">
|
||||
|
||||
```bash tab npm
|
||||
npm i @rocket/launch
|
||||
```
|
||||
|
||||
```bash tab yarn
|
||||
yarn add @rocket/launch
|
||||
```
|
||||
|
||||
```bash tab pnpm
|
||||
pnpm add @rocket/launch
|
||||
```
|
||||
|
||||
</code-tabs>
|
||||
|
||||
## Usage
|
||||
|
||||
👉 `rocket.config.js`
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
```js
|
||||
import { rocketLaunch } from '@rocket/launch';
|
||||
|
||||
/** @type {import('rocket/cli').RocketCliConfig} */
|
||||
export default ({
|
||||
presets: [rocketLaunch()],
|
||||
});
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
## Data
|
||||
|
||||
The launch preset configures [11ty data](https://www.11ty.dev/docs/data/) using a few overridable files:
|
||||
|
||||
- `site.cjs`: Responsible for most of the site-wide config
|
||||
- `rocketLaunch.json`: configures the homepage layout
|
||||
- `footer.json`: Configures the content of the footer
|
||||
|
||||
## Inline Notification
|
||||
|
||||
```js script
|
||||
import '@rocket/launch/inline-notification/inline-notification.js';
|
||||
```
|
||||
|
||||
Launch ships with `<inline-notification>`, a custom element that applies some styles similar to "info boxes". The element works for `<noscript>` users as well, as long as you don't [override](/guides/presets/overriding/) the default `noscript.css` file.
|
||||
|
||||
To add an inline notification you need to remember to import the element definition:
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
~~~markdown
|
||||
```js script
|
||||
import '@rocket/launch/inline-notification/inline-notification.js';
|
||||
```
|
||||
~~~
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
Then you can add your notification to the page. If you want to write the notification's content using markdown, just pad the opening and closing tags with empty lines.
|
||||
|
||||
There are three varieties of `<inline-notification>`, "tip", "warning", and "danger"
|
||||
|
||||
<style>
|
||||
#inline-notifications::part(tab) {
|
||||
text-transform: capitalize;
|
||||
}
|
||||
#inline-notifications code-tab::part(content) {
|
||||
display: grid;
|
||||
grid-template-columns: 1fr 1fr;
|
||||
gap: 6px;
|
||||
}
|
||||
#inline-notifications code-copy::part(copy-button) {
|
||||
position: absolute;
|
||||
top: 10px;
|
||||
border-radius: 6px;
|
||||
border: 1px solid var(--primary-lines-color);
|
||||
}
|
||||
</style>
|
||||
|
||||
<code-tabs id="inline-notifications" default-tab="tip">
|
||||
|
||||
{%for alert in alerts%}
|
||||
|
||||
<code-tab data-label="{{ alert.type }}" data-id="{{ alert.type }}" no-copy>
|
||||
|
||||
```md copy
|
||||
<inline-notification type="{{ alert.type }}">
|
||||
|
||||
{{ alert.content | safe }}
|
||||
|
||||
</inline-notification>
|
||||
```
|
||||
|
||||
<inline-notification type="{{ alert.type }}">
|
||||
|
||||
{{ alert.content | safe }}
|
||||
|
||||
</inline-notification>
|
||||
|
||||
</code-tab>
|
||||
|
||||
{%endfor%}
|
||||
|
||||
</code-tabs>
|
||||
|
||||
### Modify the Title
|
||||
|
||||
The notification title defautls to it's type. You can write a custom title with the `title` attribute.
|
||||
|
||||
<inline-notification type="tip" title="success">
|
||||
|
||||
I am a success message
|
||||
|
||||
</inline-notification>
|
||||
|
||||
```md
|
||||
<inline-notification type="tip" title="success">
|
||||
|
||||
I am a success message
|
||||
|
||||
</inline-notification>
|
||||
```
|
||||
|
||||
<inline-notification type="warning">
|
||||
|
||||
The `title` attribute does not change the title for `<noscript>` users, so don't include any critical information in it.
|
||||
|
||||
</inline-notification>
|
||||
19
docs/docs/presets/search.md
Normal file
19
docs/docs/presets/search.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# Presets >> Search ||20
|
||||
|
||||
Add a search for all your static content.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm i @rocket/search
|
||||
```
|
||||
|
||||
👉 `rocket.config.mjs`
|
||||
|
||||
```js
|
||||
import { rocketSearch } from '@rocket/search';
|
||||
|
||||
export default {
|
||||
presets: [rocketSearch()],
|
||||
};
|
||||
```
|
||||
@@ -1,9 +0,0 @@
|
||||
---
|
||||
layout: layout-api
|
||||
package: '@rocket/search'
|
||||
modules:
|
||||
- src/RocketSearch.js
|
||||
- src/RocketSearchCombobox.js
|
||||
---
|
||||
|
||||
# Presets >> Search >> Custom Elements || 20
|
||||
@@ -1,4 +0,0 @@
|
||||
# Presets >> Search || 10
|
||||
|
||||
- [Preset](./preset/)
|
||||
- [Custom Elements](./custom-elements/)
|
||||
@@ -1,36 +0,0 @@
|
||||
# Presets >> Search >> Preset || 10
|
||||
|
||||
Add a search for all your static content.
|
||||
|
||||
## Installation
|
||||
|
||||
<code-tabs collection="package-managers" default-tab="npm" align="end">
|
||||
|
||||
```bash tab npm
|
||||
npm i @rocket/search
|
||||
```
|
||||
|
||||
```bash tab yarn
|
||||
yarn add @rocket/search
|
||||
```
|
||||
|
||||
```bash tab pnpm
|
||||
pnpm add @rocket/search
|
||||
```
|
||||
|
||||
</code-tabs>
|
||||
|
||||
## Usage
|
||||
|
||||
👉 `rocket.config.js`
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
```js
|
||||
import { rocketSearch } from '@rocket/search';
|
||||
|
||||
/** @type {import('rocket/cli').RocketCliConfig} */
|
||||
export default ({
|
||||
presets: [rocketSearch()],
|
||||
});
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
@@ -1,16 +1,6 @@
|
||||
# Tools >> Check HTML Links ||30
|
||||
# Tools >> Check Html Links ||30
|
||||
|
||||
```js script
|
||||
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>
|
||||
A fast checker for broken links/references in html.
|
||||
|
||||
## Features
|
||||
|
||||
@@ -18,7 +8,7 @@ Read the [Introducing Check HTMl Links - no more bad links](../../blog/introduci
|
||||
- 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
|
||||
|
||||
@@ -26,32 +16,17 @@ Read the [Introducing Check HTMl Links - no more bad links](../../blog/introduci
|
||||
npm i -D check-html-links
|
||||
```
|
||||
|
||||
## CLI flags
|
||||
## Usage
|
||||
|
||||
| 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
|
||||
|
||||
|
||||
|
||||
## Comparison
|
||||
## Comparision
|
||||
|
||||
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)
|
||||
|
||||
|
||||
@@ -7,16 +7,12 @@ This allows your users to adjust the options before actually applying the plugin
|
||||
|
||||
Many plugin systems require you to either execute a plugin function like in `rollup`.
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
```js
|
||||
import json from '@rollup/plugin-json';
|
||||
|
||||
/** @type {import('rocket/cli').RocketCliConfig} */
|
||||
export default ({
|
||||
export default {
|
||||
plugins: [json({ preferConst: true })],
|
||||
});
|
||||
};
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
or add it in a special way like in `eleventy`
|
||||
|
||||
@@ -38,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.
|
||||
|
||||
@@ -46,7 +42,7 @@ This means if you wish to define default plugins and allow your user to override
|
||||
|
||||
## Solution
|
||||
|
||||
The plugins manager lets you orchestrate a set of "meta plugins" which are defined by
|
||||
The plugins manager let's you orchestrate a set of "meta plugins" which are defined by
|
||||
|
||||
- name
|
||||
- plugin
|
||||
@@ -197,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
|
||||
|
||||
|
||||
@@ -1,14 +1,15 @@
|
||||
# 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 JavaScript as input and/or output
|
||||
- Set HTML or JS as input and/or output
|
||||
- Optimized for browsers which support modules
|
||||
- Loads polyfills using feature detection
|
||||
- Minifies JavaScript
|
||||
- Generates a service worker
|
||||
- Minifies JS
|
||||
- Minifies lit-html templates
|
||||
|
||||
## Setup
|
||||
@@ -24,7 +25,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',
|
||||
@@ -53,7 +54,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.
|
||||
|
||||
@@ -65,9 +66,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:
|
||||
|
||||
|
||||
@@ -16,23 +16,23 @@ export default /** @type {Partial<import('@rocket/cli').RocketCliOptions>} */ ({
|
||||
});
|
||||
```
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Adding Remark/Unified Plugins
|
||||
|
||||
If you want to add a plugin to the Markdown processing you can use `setupUnifiedPlugins`.
|
||||
If you want to a plugin to the markdown processing you can use `setupUnifiedPlugins`.
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
```js
|
||||
import emoji from 'remark-emoji';
|
||||
import { addPlugin } from 'plugins-manager';
|
||||
|
||||
/** @type {Partial<import('@rocket/cli').RocketCliOptions>} */
|
||||
export default ({
|
||||
const config = {
|
||||
setupUnifiedPlugins: [addPlugin({ location: 'markdown', name: 'emoji', plugin: emoji })],
|
||||
});
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
};
|
||||
|
||||
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})`.
|
||||
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})`.
|
||||
|
||||
@@ -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 its own sidebar navigation.
|
||||
In most cases you will have multiple sections in your website and each of those sections will come with it's 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 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.
|
||||
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.
|
||||
|
||||
```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.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# First Pages >> Getting Started ||10
|
||||
|
||||
Rocket has the following prerequisites:
|
||||
Rocket is has the following prerequisits:
|
||||
|
||||
- [Node 14+](https://nodejs.org/en/)
|
||||
|
||||
@@ -10,160 +10,94 @@ Make sure they are installed before proceeding.
|
||||
|
||||
The fastest way to get started is by using an existing preset like the launch preset.
|
||||
|
||||
### Step 1. Initialize the Project Package
|
||||
1. Start with an empty new folder
|
||||
|
||||
Start by creating an empty folder for your project
|
||||
```
|
||||
mkdir my-project
|
||||
cd my-project
|
||||
npm init -y
|
||||
```
|
||||
|
||||
```bash copy
|
||||
mkdir my-project
|
||||
cd my-project
|
||||
```
|
||||
2. Install dependencies
|
||||
|
||||
Then initialize a package.json file
|
||||
```
|
||||
npm install --save-dev @rocket/cli @rocket/launch
|
||||
```
|
||||
|
||||
<code-tabs collection="package-managers" default-tab="npm" align="end">
|
||||
3. Add to your .gitignore
|
||||
|
||||
```bash tab npm
|
||||
npm init -y
|
||||
```
|
||||
```
|
||||
## Rocket ignore files (need to be the full relative path to the folders)
|
||||
docs/_merged_data/
|
||||
docs/_merged_assets/
|
||||
docs/_merged_includes/
|
||||
```
|
||||
|
||||
```bash tab yarn
|
||||
yarn init -y
|
||||
```
|
||||
<inline-notification type="danger">
|
||||
|
||||
```bash tab pnpm
|
||||
pnpm init -y
|
||||
```
|
||||
You may be tempted to skip the step above, because you're not ready to commit to git yet!
|
||||
|
||||
</code-tabs>
|
||||
|
||||
### Step 2. Install dependencies
|
||||
|
||||
<code-tabs collection="package-managers" default-tab="npm" align="end">
|
||||
|
||||
```bash tab npm
|
||||
npm install --save-dev @rocket/cli @rocket/launch
|
||||
```
|
||||
|
||||
```bash tab yarn
|
||||
yarn add -D @rocket/cli @rocket/launch
|
||||
```
|
||||
|
||||
```bash tab pnpm
|
||||
pnpm add -D @rocket/cli @rocket/launch
|
||||
```
|
||||
|
||||
</code-tabs>
|
||||
|
||||
### Step 3. Bootstrap the project
|
||||
|
||||
<code-tabs collection="package-managers" default-tab="npm" align="end">
|
||||
|
||||
```bash tab npm
|
||||
npx rocket bootstrap
|
||||
```
|
||||
|
||||
```bash tab yarn
|
||||
yarn rocket bootstrap
|
||||
```
|
||||
|
||||
```bash tab pnpm
|
||||
pnpx rocket bootstrap
|
||||
```
|
||||
|
||||
</code-tabs>
|
||||
|
||||
The `bootstrap` command creates four files in your repo:
|
||||
|
||||
- `.gitignore` containing rocket's build artifacts
|
||||
- `rocket.config.js` containing a minimal rocket config
|
||||
- `docs/.eleventyignore` required to allow you to [override templates](/guides/presets/overriding/)
|
||||
- `docs/index.md` your first page
|
||||
|
||||
It also set the package `type` to `"module"` and adds a `start` and `docs` package scripts.
|
||||
|
||||
<inline-notification type="warning">
|
||||
|
||||
If you don't want to use the `module` package type, make sure to rename the generated config file to `rocket.config.mjs`.
|
||||
Rocket uses the .gitignore file to manage it's requirements. If you skip this step, rocket will fail to deploy!
|
||||
|
||||
</inline-notification>
|
||||
|
||||
<details><summary>Default Files Contents</summary>
|
||||
4. Create a `rocket.config.mjs` (or `.js` if you have type: "module" in you package.json)
|
||||
|
||||
<code-tabs default-tab="rocket.config.js">
|
||||
```js
|
||||
import { rocketLaunch } from '@rocket/launch';
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
```js tab rocket.config.js
|
||||
import { rocketLaunch } from '@rocket/launch';
|
||||
export default {
|
||||
presets: [rocketLaunch()],
|
||||
};
|
||||
```
|
||||
|
||||
/** @type {import('rocket/cli').RocketCliConfig} */
|
||||
export default ({
|
||||
presets: [rocketLaunch()],
|
||||
});
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
5. (optionally) Create a file `.eleventyignore` (this file will be needed once you start customizing presets)
|
||||
|
||||
```md tab docs/index.md
|
||||
# Welcome to Your Rocket Site
|
||||
```
|
||||
node_modules/**
|
||||
/docs/_assets
|
||||
/docs/_includes
|
||||
/docs/_data
|
||||
```
|
||||
|
||||
Add your markdown content here.
|
||||
```
|
||||
<inline-notification type="warning" title="note">
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
All further pathes are relative to your project root (my-project in this case)
|
||||
|
||||
```html tab docs/.eleventyignore
|
||||
_assets
|
||||
_includes
|
||||
_data
|
||||
```
|
||||
</inline-notification>
|
||||
|
||||
```html tab .gitignore
|
||||
## Rocket ignore files (need to be the full relative path to the folders)
|
||||
docs/_merged_data/
|
||||
docs/_merged_assets/
|
||||
docs/_merged_includes/
|
||||
```
|
||||
## Add your first page
|
||||
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
</code-tabs>
|
||||
|
||||
</details>
|
||||
|
||||
## Add your First Page
|
||||
|
||||
Bootstrap created the file `docs/index.md`. Open it in your editor and change it to suit your needs.
|
||||
|
||||
<small>NOTE: This tutorial assumes you are familiar with Markdown, for page authoring.</small>
|
||||
👉 `docs/index.md`
|
||||
|
||||
```md
|
||||
# Welcome to Your Rocket Site
|
||||
# Welcome to your Rocket site
|
||||
|
||||
Add your markdown content here.
|
||||
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.
|
||||
|
||||
## Startup
|
||||
## Start up:
|
||||
|
||||
👉 `package.json`
|
||||
|
||||
Add `"start": "rocket start"` to your package.json
|
||||
|
||||
```json
|
||||
"scripts": {
|
||||
"start": "rocket start"
|
||||
}
|
||||
```
|
||||
|
||||
Now you can launch your site locally with
|
||||
|
||||
<code-tabs collection="package-managers" default-tab="npm" align="end">
|
||||
|
||||
```bash tab npm
|
||||
npm start
|
||||
```bash
|
||||
npm run start
|
||||
```
|
||||
|
||||
```bash tab yarn
|
||||
yarn start
|
||||
```
|
||||
|
||||
```bash tab pnpm
|
||||
pnpx start
|
||||
```
|
||||
|
||||
</code-tabs>
|
||||
|
||||
## Taking Inventory Before Adding Pages:
|
||||
|
||||
We're about to add both content and navigation at the same time.
|
||||
@@ -173,16 +107,11 @@ It can be helpful to take an inventory, before we start, to separate basic setup
|
||||
- We built the project with basic npm commands
|
||||
- Added a couple required files manually
|
||||
- Adjusted package.json
|
||||
- **docs/index.md** to seed the content
|
||||
- **doc/index.md** to seed the content
|
||||
- Launches with `npm start`
|
||||
|
||||
That's all it takes to get a new super-fast and powerful site, complete with a service worker, default styling, navigation, and ready to deploy as a plain old static files.
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Adding Pages](../adding-pages/)
|
||||
- [Using Presets](../../presets/getting-started/)
|
||||
|
||||
```js script
|
||||
import '@rocket/launch/inline-notification/inline-notification.js';
|
||||
```
|
||||
|
||||
@@ -1,29 +0,0 @@
|
||||
# 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
|
||||
@@ -1,6 +1,6 @@
|
||||
# First Pages >> Linking ||20
|
||||
|
||||
Standard Markdown applies. You can link like this:
|
||||
Standard markdown applies and you can link via
|
||||
|
||||
```md
|
||||
[visible label](./path/to/other-file.md)
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# First Pages >> Managing sidebar || 30
|
||||
# First Pages >> Managing sidebar ||30
|
||||
|
||||
The sidebar will show all the content of the current section.
|
||||
|
||||
@@ -21,7 +21,7 @@ Will be ordered as `First`, `Second`,
|
||||
|
||||
## How it works
|
||||
|
||||
Internally `# Foo >> Bar >> Baz ||20` gets converted to.
|
||||
Internally `# Foo >> Bar >> Baz ||20` get's converted to.
|
||||
|
||||
```
|
||||
---
|
||||
@@ -33,11 +33,10 @@ eleventyNavigation:
|
||||
---
|
||||
```
|
||||
|
||||
<!--
|
||||
You can also look at this live playground:
|
||||
|
||||
```js story
|
||||
import { html } from '@mdjs/mdjs-preview';
|
||||
import { html } from 'lit-html';
|
||||
|
||||
export const headlineConverter = () => html`
|
||||
<p>
|
||||
@@ -46,12 +45,5 @@ export const headlineConverter = () => html`
|
||||
</p>
|
||||
`;
|
||||
```
|
||||
-->
|
||||
|
||||
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.
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# First Pages >> URLs ||50
|
||||
# First Pages >> Urls ||100
|
||||
|
||||
URLs will be represented by the folder structure.
|
||||
Urls will be represented by the folder structure...
|
||||
|
||||
You can use front matter with a [permalink](https://www.11ty.dev/docs/permalinks/) to override.
|
||||
You can use a frontmatter with permalink to override
|
||||
|
||||
@@ -1,49 +1,25 @@
|
||||
# First Pages >> Use JavaScript || 40
|
||||
# First Pages >> Use JavaScript ||40
|
||||
|
||||
If you would like to add JavaScript to a page, you can do it inline using the `script` markdown directive. The script you write runs on the page as a module.
|
||||
You can use `js script` to execute javascript (type = module)
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
~~~markdown
|
||||
````
|
||||
```js script
|
||||
const message = 'Hello, World!';
|
||||
console.log(message);
|
||||
console.log('foo');
|
||||
```
|
||||
~~~
|
||||
<!-- prettier-ignore-end -->
|
||||
````
|
||||
|
||||
Adding the above will log `Hello, World!` to the console without adding a global `message` variable.
|
||||
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. Imagine you had some `magic-reveal` element that you wanted to use on a page:
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
~~~markdown
|
||||
````
|
||||
```js script
|
||||
import 'magic-reveal/magic-reveal.js';
|
||||
```
|
||||
|
||||
<magic-reveal>
|
||||
|
||||
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.
|
||||
This text will get magically revealed. I can **still** use markdown as long as between the opening/closing tag there is an empty line.
|
||||
|
||||
</magic-reveal>
|
||||
~~~
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
## Component Story Format
|
||||
|
||||
You can also add storybook-style CSF (v2 only) stories to a page using `js story` or `js preview-story`, just make sure to import `html` from `@mdjs/mdjs-preview` instead of from `lit` or `lit-html`.
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
~~~markdown
|
||||
```js story
|
||||
import { html } from '@mdjs/mdjs-preview';
|
||||
|
||||
export const StoryPreview = () => html`
|
||||
<p>Use stories in Rocket!</p>
|
||||
`;
|
||||
```
|
||||
~~~
|
||||
<!-- prettier-ignore-end -->
|
||||
````
|
||||
|
||||
or you can use `js story`, `js preview-story`, ...
|
||||
|
||||
@@ -1 +1 @@
|
||||
# Go Live || 40
|
||||
# Go Live ||40
|
||||
|
||||
@@ -1,52 +1,51 @@
|
||||
# Go Live >> Overview || 10
|
||||
# Go Live >> Overview ||10
|
||||
|
||||
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 exist, a "famous" 404 Page Not Found error occurs.
|
||||
When a user enters a url that does not exists then a "famous" 404 page not found error occures.
|
||||
Many servers are configured to handle this automatically and to serve a 404.html page instead.
|
||||
|
||||
The [Rocket Launch preset](../../docs/presets/launch.md) ships a default 404 template you can use.
|
||||
The [Rocket Lauch Preset](../../docs/presets/launch.md) ships a default 404 template you can use.
|
||||
|
||||
To enable it, you need to create a `404.md` and use the 404 layout.
|
||||
To enable it you need to creating a 404.md and use the 404 layout.
|
||||
|
||||
👉 `docs/404.md`
|
||||
|
||||
```markdown copy
|
||||
```
|
||||
---
|
||||
layout: layout-404
|
||||
layout: 404.njk
|
||||
permalink: 404.html
|
||||
---
|
||||
```
|
||||
|
||||
This results in a `404.html` page, which will do nothing by itself. But many hosting services like netlify or firebase, for example will redirect 404s to this `404.html` by default.
|
||||
|
||||
If the hosting provider doesn't already do this, then you may be able to accomplish it via some settings for example by using a `.htaccess` file in case of an apache server.
|
||||
|
||||
## 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`
|
||||
|
||||
```markdown copy
|
||||
{% raw %}
|
||||
|
||||
```
|
||||
---
|
||||
layout: layout-raw
|
||||
layout: pure-content.njk
|
||||
permalink: /sitemap.xml
|
||||
eleventyExcludeFromCollections: true
|
||||
---
|
||||
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
|
||||
{% raw %}{% for page in collections.all %}
|
||||
{% for page in collections.all %}
|
||||
<url>
|
||||
<loc>{{ rocketConfig.absoluteBaseUrl }}{{ page.url | url }}</loc>
|
||||
<lastmod>{{ page.date.toISOString() }}</lastmod>
|
||||
<changefreq>{{ page.data.changeFreq if page.data.changeFreq else "monthly" }}</changefreq>
|
||||
</url>
|
||||
{% endfor %}{% endraw %}
|
||||
{% endfor %}
|
||||
</urlset>
|
||||
```
|
||||
|
||||
{% endraw %}
|
||||
|
||||
@@ -1,27 +1,27 @@
|
||||
# Go Live >> Social Media || 20
|
||||
# Go Live >> Social Media ||20
|
||||
|
||||
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 | url }}" width="1200" height="630" alt="Social Media Image of this page" style="border: 1px solid #000" />
|
||||
<img src="{{ socialMediaImage }}" width="1200" height="630" alt="Social Media Image of this page" style="border: 1px solid #000" />
|
||||
|
||||
There are multiple ways you can modify it.
|
||||
|
||||
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.
|
||||
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
|
||||
## Setting it via frontMatter
|
||||
|
||||
You can create your own image and link it with something like this
|
||||
|
||||
```markdown copy
|
||||
```
|
||||
---
|
||||
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".
|
||||
|
||||
@@ -29,7 +29,7 @@ You can create an `11tydata.cjs` file next to your page. If your page is `docs/g
|
||||
|
||||
In there you can use the default `createSocialImage` but provide your own values.
|
||||
|
||||
```js copy
|
||||
```js
|
||||
const { createSocialImage } = require('@rocket/cli');
|
||||
|
||||
module.exports = async function () {
|
||||
@@ -39,7 +39,7 @@ module.exports = async function () {
|
||||
subTitle2: 'in 5 Minutes',
|
||||
footer: 'Rocket Guides',
|
||||
// you can also override the svg only for this page by providing
|
||||
// createSocialImageSvg: async () => '{%raw%}<svg>...</svg>{%endraw%}'
|
||||
// createSocialImageSvg: async () => '<svg>...</svg>'
|
||||
});
|
||||
return {
|
||||
socialMediaImage,
|
||||
@@ -47,19 +47,18 @@ module.exports = async function () {
|
||||
};
|
||||
```
|
||||
|
||||
## Override the Default Image
|
||||
## 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.
|
||||
For that you can provide your own function which returns a string of an svg to render the image.
|
||||
|
||||
👉 `rocket.config.js`
|
||||
👉 `rocket.config.mjs`
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
```js copy
|
||||
```js
|
||||
import { adjustPluginOptions } from 'plugins-manager';
|
||||
|
||||
/** @type {import('@rocket/cli').RocketCliOptions} */
|
||||
export default ({
|
||||
/** @type {Partial<import("@rocket/cli").RocketCliOptions>} */
|
||||
const config = {
|
||||
setupEleventyComputedConfig: [
|
||||
adjustPluginOptions('socialMediaImage', {
|
||||
createSocialImageSvg: async ({
|
||||
@@ -96,69 +95,37 @@ export default ({
|
||||
},
|
||||
}),
|
||||
],
|
||||
});
|
||||
};
|
||||
|
||||
export default config;
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
## Using an SVG File as a src with Nunjucks
|
||||
## 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.
|
||||
If you have multiple variations it may be easier to save them as svg files and using a template system
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
<code-tabs default-tab="rocket.config.js">
|
||||
WARNING: Untested example
|
||||
|
||||
```js tab rocket.config.js
|
||||
👉 `rocket.config.mjs`
|
||||
|
||||
{% raw %}
|
||||
|
||||
```js
|
||||
import { adjustPluginOptions } from 'plugins-manager';
|
||||
|
||||
/** @type {import('@rocket/cli').RocketCliOptions} */
|
||||
export default ({
|
||||
/** @type {Partial<import("@rocket/cli").RocketCliOptions>} */
|
||||
const config = {
|
||||
setupEleventyComputedConfig: [
|
||||
adjustPluginOptions('socialMediaImage', {
|
||||
createSocialImageSvg: async (args = {}) => {
|
||||
const svgBuffer = await fs.promises.readFile('/path/to/your/template.svg');
|
||||
// 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 %}
|
||||
```
|
||||
|
||||
```svg tab /path/to/your/template.svg
|
||||
{%raw%}<svg xmlns="http://www.w3.org/2000/svg" fill="#e63946" viewBox="0 0 511.998 511.998">
|
||||
<text font-family="'Open Sans', sans-serif" font-size="39" transform="translate(422.99 408.53)">
|
||||
<tspan x="-89.26" y="12.25">{{ title }}</tspan>
|
||||
</text>
|
||||
<path d="M98.649 430.256c-46.365 28.67-71.17 30.939-78.916 23.51-7.75-7.433-6.519-32.307 20.182-79.832 24.953-44.412 65.374-96.693 113.818-147.211l-11.279-10.817c-49.33 51.442-90.583 104.845-116.163 150.373-19.228 34.22-37.848 79.134-17.375 98.766 5.84 5.6 13.599 7.935 22.484 7.935 22.269 0 51.606-14.677 75.469-29.432 44.416-27.464 96.044-70.919 145.373-122.362l-11.279-10.817c-48.446 50.519-98.987 93.095-142.314 119.887zM254.734 294.95l-18.47-17.71 10.816-11.281 18.47 17.71zM285.516 324.473l-18.47-17.71 10.816-11.28 18.47 17.71zM315.543 317.807l-73.886-70.847 10.816-11.28 73.886 70.846zM500.916 41.287c-7.769 1.59-76.412 16.062-93.897 34.294l-50.728 52.899-114.703-3.629-39.198 40.876 79.28 40.569-21.755 22.687 72.848 69.858 21.755-22.687 43.857 77.51 39.197-40.876-8.433-114.451 50.727-52.899c17.485-18.234 29.067-87.422 30.331-95.251l1.801-11.169-11.082 2.269zM228.209 161.383l19.842-20.692 93.688 2.964-48.775 50.864-64.755-33.136zm173.423 166.303l-35.822-63.308 48.776-50.865 6.886 93.482-19.84 20.691zm-69.334-50.943l-50.287-48.223L412.89 92.037l50.288 48.223-130.88 136.483zm140.711-148.707l-48.316-46.334c14.54-8.427 44.787-17.217 68.076-22.632-4.433 23.497-11.949 54.085-19.76 68.966z"/>
|
||||
<path d="M326.335 257.25l-24.628-23.614 10.816-11.28 24.628 23.615zM431.385 134.414l-11.808 12.315-11.28-10.816 11.808-12.315zM401.838 165.183l-11.28-10.816 11.807-12.314 11.28 10.816zM384.121 183.66l-11.28-10.816 11.807-12.314 11.28 10.816zM175.19 184.515l11.051 11.05-23.582 23.582-11.05-11.05zM190.903 168.796l11.05 11.052-7.863 7.86-11.05-11.052z"/>
|
||||
</svg>{%endraw%}
|
||||
```
|
||||
|
||||
</code-tabs>
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
## 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
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
```js copy
|
||||
export default ({
|
||||
start: {
|
||||
createSocialMediaImages: true,
|
||||
},
|
||||
});
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
Similarly, if you never want to create social media images even during build then you can globally disable it via
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
```js copy
|
||||
export default ({
|
||||
createSocialMediaImages: true,
|
||||
});
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
@@ -5,19 +5,4 @@ eleventyNavigation:
|
||||
order: 10
|
||||
---
|
||||
|
||||
Rocket helps you generate static pages from Markdown files while giving you the flexibility to sprinkle in some JavaScript where needed.
|
||||
|
||||
- [First Pages](./first-pages/getting-started/) Learn how to bootstrap and run a Rocket site
|
||||
- [Adding Pages](./first-pages/adding-pages/) Create your own content pages
|
||||
- [Linking](./first-pages/link-to-other-pages/) Link between yuor markdown pages
|
||||
- [Managing Sidebar](./first-pages/manage-sidebar/) Customize your site's navigation
|
||||
- [Use JavaScript](./first-pages/use-javascript/) Write inline scripts in markdown
|
||||
- [URLs](./first-pages/urls/) Customize your pages' permalinks
|
||||
- [Layouts](./first-pages/layouts/) Give your page a custom layout
|
||||
- [Presets](./presets/getting-started/) Customize Rocket with config presets
|
||||
- [Overriding](./presets/overriding/) Override preset templates
|
||||
- [Using Templates](./presets/using-templates/) Make use of preset templates
|
||||
- [Create Your Own](./presets/create-your-own/getting-started/) Write and publish your own presets
|
||||
- [Configuration](./configuration/getting-started/) Make Rocket your own
|
||||
- [Go Live](./go-live/overview/) Publish your site
|
||||
- [Social Media](./go-live/social-media/) Generate social images
|
||||
Rocket is a fundamentally straight forward way to generate static pages while still allowing to sprinkle in some JavaScript where needed.
|
||||
|
||||
106
docs/guides/presets/create-your-own.md
Normal file
106
docs/guides/presets/create-your-own.md
Normal file
@@ -0,0 +1,106 @@
|
||||
# Presets >> Create your own || 90
|
||||
|
||||
A preset is setup function and a folder including `_assets`, `_data` and `_includes` (all optional).
|
||||
|
||||
To play around with a preset you can create a folder `fire-theme`.
|
||||
|
||||
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()],
|
||||
};
|
||||
```
|
||||
````
|
||||
@@ -1,54 +0,0 @@
|
||||
# Presets >> Create your Own >> Getting Started || 10
|
||||
|
||||
A preset is a setup function and a folder including `_assets`, `_data` and `_includes` (all optional).
|
||||
|
||||
To play around with a preset you can create a folder `fire-theme`.
|
||||
|
||||
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 copy
|
||||
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 we could override the full `layout.css` by adding it like so
|
||||
|
||||
👉 `fire-theme/layout.css`
|
||||
|
||||
```css copy
|
||||
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`
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
```js copy
|
||||
import { rocketLaunch } from '@rocket/launch';
|
||||
import { fireTheme } from 'path/to/fire-theme/fireTheme.js';
|
||||
|
||||
/** @type {import('@rocket/cli').RocketCliOptions} */
|
||||
export default ({
|
||||
presets: [rocketLaunch(), fireTheme()],
|
||||
});
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
@@ -1,22 +0,0 @@
|
||||
# Presets >> Create your Own >> Hooks || 20
|
||||
|
||||
Your preset can hook into the rocket lifecycle by specifying a function for `before11ty`. This function runs before 11ty calls it's write method. If it is an async function, Rocket will await it's promise.
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
```js
|
||||
/** @type {import('@rocket/cli').RocketPreset} */
|
||||
export default ({
|
||||
async before11ty() {
|
||||
await copyDataFiles();
|
||||
},
|
||||
});
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
## Preset Interface
|
||||
|
||||
The full preset interface is copied below for your reference.
|
||||
|
||||
```ts
|
||||
{% include ../../../../packages/cli/types/preset.d.ts %}
|
||||
```
|
||||
@@ -1,7 +0,0 @@
|
||||
# Presets >> Create your Own || 40
|
||||
|
||||
## Contents
|
||||
|
||||
- [Getting Started](./getting-started/)
|
||||
- [Hooks](./hooks/)
|
||||
- [Publishing your Preset](./publishing/)
|
||||
@@ -1,60 +0,0 @@
|
||||
# Presets >> Create your Own >> Publishing || 100
|
||||
|
||||
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
|
||||
- use the convention `rocket-preset-${name}`
|
||||
- for this example we use `rocket-preset-fire-theme`.
|
||||
2. Create a new folder `fire-theme`
|
||||
3. Create a folder `fire-theme/preset` copy `fireTheme.js` from [above](../getting-started/) into `preset/fireTheme.js`
|
||||
4. Add a 👉 `package.json`
|
||||
|
||||
```json copy
|
||||
{
|
||||
"name": "rocket-preset-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 copy
|
||||
export { fireTheme } from './preset/fireTheme.js';
|
||||
```
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
6. Add a 👉 `README.md`
|
||||
|
||||
~~~markdown copy
|
||||
# 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';
|
||||
|
||||
/** @type {import('@rocket/cli').RocketCliOptions} */
|
||||
export default ({
|
||||
presets: [rocketLaunch(), fireTheme()],
|
||||
});
|
||||
```
|
||||
~~~
|
||||
|
||||
<!-- prettier-ignore-end -->
|
||||
@@ -1,36 +1,7 @@
|
||||
# Presets >> Getting Started || 10
|
||||
# Presets >> Getting Started ||10
|
||||
|
||||
Presets are partial rocket configs that combine any number of plugins to add specific features. Rocket is built on these presets, like `rocketLaunch`, `rocketBlog`, and `rocketSearch`
|
||||
Presets are ...
|
||||
|
||||
You can use a preset via the config by adding it to the `presets` array
|
||||
You can use a preset via the config...
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
```js copy
|
||||
import { rocketLaunch } from '@rocket/launch';
|
||||
import { rocketBlog } from '@rocket/blog';
|
||||
import { rocketSearch } from '@rocket/search';
|
||||
|
||||
/** @type {import('@rocket/cli').RocketCliOptions} */
|
||||
export default ({
|
||||
presets: [rocketLaunch(), rocketBlog(), rocketSearch()],
|
||||
});
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
## Community Presets
|
||||
|
||||
There are a number of community-made presets available:
|
||||
|
||||
<!--
|
||||
-- Thank you for your interest in rocket. To add your preset,
|
||||
-- follow the format below. Please add your preset in alphabetical order.
|
||||
-->
|
||||
|
||||
- [rocket-preset-code-tabs](https://www.npmjs.com/package/rocket-preset-code-tabs) - Add tab elements for code blocks
|
||||
- [rocket-preset-custom-elements-manifest](https://www.npmjs.com/package/rocket-preset-custom-elements-manifest) - Documents code generation for JavaScript libraries, particularly custom elements.
|
||||
- [rocket-preset-markdown-directive](https://www.npmjs.com/package/rocket-preset-markdown-directive) - Add your own custom md code block directives
|
||||
- [rocket-preset-playground-elements](https://www.npmjs.com/package/rocket-preset-playground-elements) - Live code editors that run in-browser
|
||||
- [rocket-preset-slide-decks](https://www.npmjs.com/package/rocket-preset-slide-decks) - Slide decks in Markdown and HTML
|
||||
- [rocket-preset-webcomponents-dev](https://www.npmjs.com/package/rocket-preset-webcomponents-dev) - Live code editors that run on webcomponents.dev
|
||||
|
||||
> Want your plugin listed here? Please [create a PR](https://github.com/modernweb-dev/rocket/edit/main/docs/guides/presets/getting-started.md)!
|
||||
You can load multiple presets.
|
||||
|
||||
@@ -1,6 +1 @@
|
||||
# Presets || 20
|
||||
|
||||
- [Getting Started](./getting-started/)
|
||||
- [Overriding](./overriding/)
|
||||
- [Using Templates](./using-templates/)
|
||||
- [Create Your Own](./create-your-own/getting-started/)
|
||||
|
||||
@@ -4,23 +4,4 @@ All loaded presets will be combined but you can override each file.
|
||||
|
||||
Take a look at `docs/_merged_includes` and override what you want to override by placing the same filename into `_includes`.
|
||||
|
||||
For example, to override the css files loaded in the `<head>`,
|
||||
|
||||
```bash
|
||||
cp docs/_merged_includes/_joiningBlocks/head/40-stylesheets.njk \
|
||||
docs/_includes/_joiningBlocks/head/40-stylesheets.njk
|
||||
```
|
||||
|
||||
then edit the file to suit your needs.
|
||||
|
||||
Also works for `_assets`, `_data` ...
|
||||
|
||||
<inline-notification type="warning">
|
||||
|
||||
If you don't [add `.eleventyignore`](/guides/first-pages/getting-started/#setup), you may receive error messages when running `rocket build`.
|
||||
|
||||
</inline-notification>
|
||||
|
||||
```js script
|
||||
import '@rocket/launch/inline-notification/inline-notification.js';
|
||||
```
|
||||
|
||||
@@ -1,71 +1,3 @@
|
||||
# Presets >> Using templates ||30
|
||||
|
||||
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`
|
||||
|
||||
<inline-notification type="tip">
|
||||
|
||||
File names without an order/number in front are considered with the order number `10 000` so the generally end up at the bottom. If you need something even below unordered items you can use numbers that are greater then `10 000`.
|
||||
|
||||
_Note: For unordered files there is no guarantee of any order._
|
||||
|
||||
</inline-notification>
|
||||
|
||||
## 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)
|
||||
|
||||
```js script
|
||||
import '@rocket/launch/inline-notification/inline-notification.js';
|
||||
```
|
||||
Most presetse have specific entry files you can override...
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Rocket
|
||||
layout: layout-home-background
|
||||
layout: home.njk
|
||||
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
|
||||
|
||||
@@ -1,5 +0,0 @@
|
||||
---
|
||||
layout: layout-simulator
|
||||
eleventyExcludeFromCollections: true
|
||||
excludeFromSearch: true
|
||||
---
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
layout: layout-raw
|
||||
layout: pure-content.njk
|
||||
permalink: /sitemap.xml
|
||||
eleventyExcludeFromCollections: true
|
||||
---
|
||||
|
||||
21
package.json
21
package.json
@@ -8,18 +8,16 @@
|
||||
},
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"analyze": "run-s analyze:* format:*",
|
||||
"analyze:analyze": "node scripts/workspaces-scripts-bin.mjs analyze",
|
||||
"build": "npm run build:packages && npm run build:site",
|
||||
"build:packages": "node scripts/workspaces-scripts-bin.mjs build:package",
|
||||
"build:site": "run-s analyze:* rocket:build",
|
||||
"build:site": "npm run rocket:build",
|
||||
"changeset": "changeset",
|
||||
"debug": "web-test-runner --watch --config web-test-runner-chrome.config.mjs",
|
||||
"debug:firefox": "web-test-runner --watch --config web-test-runner-firefox.config.mjs",
|
||||
"debug:webkit": "web-test-runner --watch --config web-test-runner-webkit.config.mjs",
|
||||
"format": "run-s format:*",
|
||||
"format": "npm run format:eslint && npm run format:prettier",
|
||||
"format:eslint": "eslint --ext .ts,.js,.mjs,.cjs . --fix",
|
||||
"format:prettier": "node node_modules/prettier/bin-prettier.js \"**/*.{ts,js,mjs,cjs,md}\" \"**/!(expected)/package.json\" --write --ignore-path .eslintignore",
|
||||
"format:prettier": "node node_modules/prettier/bin-prettier.js \"**/*.{ts,js,mjs,cjs,md}\" \"**/package.json\" --write --ignore-path .eslintignore",
|
||||
"lint": "run-p lint:*",
|
||||
"lint:eslint": "eslint --ext .ts,.js,.mjs,.cjs .",
|
||||
"lint:prettier": "node node_modules/prettier/bin-prettier.js \"**/*.{ts,js,mjs,cjs,md}\" --check --ignore-path .eslintignore",
|
||||
@@ -33,7 +31,6 @@
|
||||
"setup": "npm run setup:ts-configs && npm run build:packages",
|
||||
"setup:patches": "npx patch-package",
|
||||
"setup:ts-configs": "node scripts/generate-ts-configs.mjs",
|
||||
"prestart": "yarn analyze",
|
||||
"start": "node packages/cli/src/cli.js start",
|
||||
"test": "yarn test:node && yarn test:web",
|
||||
"test:node": "mocha \"packages/*/test-node/**/*.test.{ts,js,mjs,cjs}\" --timeout 5000 --reporter dot --exit",
|
||||
@@ -48,8 +45,7 @@
|
||||
},
|
||||
"devDependencies": {
|
||||
"@changesets/cli": "^2.12.0",
|
||||
"@custom-elements-manifest/analyzer": "^0.4.12",
|
||||
"@open-wc/testing": "^3.0.0-next.1",
|
||||
"@open-wc/testing": "^2.5.32",
|
||||
"@rollup/plugin-commonjs": "^17.0.0",
|
||||
"@rollup/plugin-json": "^4.1.0",
|
||||
"@rollup/plugin-typescript": "^8.1.0",
|
||||
@@ -63,12 +59,11 @@
|
||||
"@web/test-runner": "^0.12.2",
|
||||
"@web/test-runner-commands": "^0.4.0",
|
||||
"@web/test-runner-playwright": "^0.8.0",
|
||||
"cem-plugin-readme": "^0.1.3",
|
||||
"chai": "^4.2.0",
|
||||
"concurrently": "^5.3.0",
|
||||
"copyfiles": "^2.4.1",
|
||||
"deepmerge": "^4.2.2",
|
||||
"esbuild": "^0.12.15",
|
||||
"esbuild": "^0.8.31",
|
||||
"eslint": "^7.17.0",
|
||||
"eslint-config-prettier": "^7.1.0",
|
||||
"hanbi": "^0.4.1",
|
||||
@@ -80,16 +75,14 @@
|
||||
"onchange": "^7.1.0",
|
||||
"prettier": "^2.2.1",
|
||||
"prettier-plugin-package": "^1.3.0",
|
||||
"puppeteer": "^9.0.0",
|
||||
"puppeteer": "^5.5.0",
|
||||
"remark-emoji": "^2.1.0",
|
||||
"rimraf": "^3.0.2",
|
||||
"rocket-preset-code-tabs": "^0.2.6",
|
||||
"rocket-preset-custom-elements-manifest": "^0.1.7",
|
||||
"rollup": "^2.36.1",
|
||||
"rollup-plugin-terser": "^7.0.2",
|
||||
"sinon": "^9.2.3",
|
||||
"ts-node": "^9.1.1",
|
||||
"typescript": "^4.3.2"
|
||||
"typescript": "^4.1.3"
|
||||
},
|
||||
"eslintConfig": {
|
||||
"parser": "@typescript-eslint/parser",
|
||||
|
||||
@@ -1,22 +1,5 @@
|
||||
# @rocket/blog
|
||||
|
||||
## 0.3.1
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- a5661b8: Updates dependencies
|
||||
|
||||
## 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
|
||||
|
||||
@@ -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/).
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@rocket/blog",
|
||||
"version": "0.3.1",
|
||||
"version": "0.2.0",
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
},
|
||||
@@ -38,6 +38,6 @@
|
||||
"testing"
|
||||
],
|
||||
"dependencies": {
|
||||
"plugins-manager": "^0.2.4"
|
||||
"plugins-manager": "^0.2.0"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
/** BLOG OVERVIEW **************************************************************************/
|
||||
|
||||
body[layout='layout-blog-details'] rocket-navigation > ul > li.current::before {
|
||||
body[layout='blog-details'] rocket-navigation > ul > li.current::before {
|
||||
display: none;
|
||||
}
|
||||
|
||||
body[layout='layout-blog-details'] #sidebar-nav li.anchor a:hover::before {
|
||||
body[layout='blog-details'] #sidebar-nav li.anchor a:hover::before {
|
||||
display: none;
|
||||
}
|
||||
|
||||
@@ -48,7 +48,8 @@ body[layout='layout-blog-details'] #sidebar-nav li.anchor a:hover::before {
|
||||
}
|
||||
|
||||
@media screen and (min-width: 1024px) {
|
||||
body[layout='layout-blog-details'] #sidebar {
|
||||
body[layout='blog-details'] #sidebar {
|
||||
display: block;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,3 +0,0 @@
|
||||
{% if cover_image %}
|
||||
<img src="{{ cover_image | url }}" alt="">
|
||||
{% endif %}
|
||||
@@ -1 +0,0 @@
|
||||
{% include 'partials/_shared/blog-content-footer.njk' %}
|
||||
@@ -1 +0,0 @@
|
||||
{% include 'partials/_shared/logoLink.njk' %}
|
||||
@@ -1,25 +0,0 @@
|
||||
<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>
|
||||
@@ -1,20 +0,0 @@
|
||||
<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>
|
||||
@@ -1 +0,0 @@
|
||||
<link rel="stylesheet" href="{{ '/_assets/rocket-blog.css' | asset | url }}">
|
||||
57
packages/blog/preset/_includes/blog-details.njk
Normal file
57
packages/blog/preset/_includes/blog-details.njk
Normal file
@@ -0,0 +1,57 @@
|
||||
{% 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 %}
|
||||
37
packages/blog/preset/_includes/blog-overview.njk
Normal file
37
packages/blog/preset/_includes/blog-overview.njk
Normal file
@@ -0,0 +1,37 @@
|
||||
{% 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 %}
|
||||
@@ -1,11 +0,0 @@
|
||||
{% 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 %}
|
||||
@@ -1,5 +0,0 @@
|
||||
{% extends 'layout-home.njk' %}
|
||||
|
||||
{% block content %}
|
||||
{% include 'partials/_layoutBlogOverview/content.njk' %}
|
||||
{% endblock content %}
|
||||
@@ -1,5 +0,0 @@
|
||||
<main class="markdown-body">
|
||||
{% for blockName, blockPath in _joiningBlocks._layoutBlogDetails.content %}
|
||||
{% include blockPath %}
|
||||
{% endfor %}
|
||||
</main>
|
||||
@@ -1,7 +0,0 @@
|
||||
<rocket-drawer id="sidebar">
|
||||
<nav slot="content" id="sidebar-nav">
|
||||
{% for blockName, blockPath in _joiningBlocks._layoutBlogDetails.sidebar %}
|
||||
{% include blockPath %}
|
||||
{% endfor %}
|
||||
</nav>
|
||||
</rocket-drawer>
|
||||
@@ -1,5 +0,0 @@
|
||||
<main class="markdown-body">
|
||||
{% for blockName, blockPath in _joiningBlocks._layoutBlogOverview.content %}
|
||||
{% include blockPath %}
|
||||
{% endfor %}
|
||||
</main>
|
||||
@@ -13,6 +13,9 @@ 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.
|
||||
@@ -38,7 +41,7 @@ export function rocketBlog({ section = SECTION, postCollection = POST_COLLECTION
|
||||
|
||||
const posts = eleventyConfig.collections[section](collection);
|
||||
posts.forEach(page => {
|
||||
page.data.layout = 'layout-blog-details';
|
||||
page.data.layout = 'post';
|
||||
});
|
||||
return posts;
|
||||
});
|
||||
|
||||
@@ -1,29 +1,5 @@
|
||||
# @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
|
||||
|
||||
@@ -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/).
|
||||
|
||||
@@ -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
|
||||
`;
|
||||
|
||||
@@ -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 {
|
||||
|
||||
@@ -6,7 +6,3 @@
|
||||
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';
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@rocket/building-rollup",
|
||||
"version": "0.3.1",
|
||||
"version": "0.1.2",
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
},
|
||||
@@ -13,7 +13,6 @@
|
||||
},
|
||||
"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"
|
||||
@@ -55,16 +54,11 @@
|
||||
"@babel/preset-env": "^7.12.11",
|
||||
"@rollup/plugin-babel": "^5.2.2",
|
||||
"@rollup/plugin-node-resolve": "^11.0.1",
|
||||
"@rollup/plugin-replace": "^2.4.2",
|
||||
"@web/rollup-plugin-html": "^1.8.0",
|
||||
"@web/rollup-plugin-html": "^1.4.0",
|
||||
"@web/rollup-plugin-import-meta-assets": "^1.0.4",
|
||||
"@web/rollup-plugin-polyfills-loader": "^1.1.0",
|
||||
"@web/rollup-plugin-polyfills-loader": "^1.0.3",
|
||||
"browserslist": "^4.16.1",
|
||||
"rollup-plugin-terser": "^7.0.2",
|
||||
"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"
|
||||
"rollup-plugin-workbox": "^6.1.0"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -22,7 +22,7 @@ export function createBasicMetaConfig(userConfig = { output: {} }) {
|
||||
const assetName = `[${developmentMode ? 'name' : 'hash'}][extname]`;
|
||||
|
||||
const config = {
|
||||
preserveEntrySignatures: 'strict',
|
||||
preserveEntrySignatures: false,
|
||||
treeshake: !developmentMode,
|
||||
setupPlugins: [],
|
||||
...userConfig,
|
||||
|
||||
@@ -15,6 +15,10 @@ export function createMpaMetaConfig(userConfig = { output: {}, setupPlugins: []
|
||||
adjustPluginOptions('html', {
|
||||
flattenOutput: false,
|
||||
}),
|
||||
adjustPluginOptions('workbox', config => {
|
||||
delete config.navigateFallback;
|
||||
return config;
|
||||
}),
|
||||
...config.setupPlugins,
|
||||
];
|
||||
|
||||
|
||||
@@ -1,91 +0,0 @@
|
||||
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 };
|
||||
}
|
||||
@@ -1,4 +1,6 @@
|
||||
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';
|
||||
@@ -35,6 +37,31 @@ 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',
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
{
|
||||
|
||||
@@ -9,13 +9,13 @@ describe('plugin count', () => {
|
||||
expect(config.plugins.length).to.equal(3);
|
||||
});
|
||||
|
||||
it('createSpaConfig has 6 plugins', () => {
|
||||
it('createSpaConfig has 7 plugins', () => {
|
||||
const config = createSpaConfig();
|
||||
expect(config.plugins.length).to.equal(6);
|
||||
expect(config.plugins.length).to.equal(7);
|
||||
});
|
||||
|
||||
it('createMpaConfig has 6 plugins', () => {
|
||||
it('createMpaConfig has 7 plugins', () => {
|
||||
const config = createMpaConfig();
|
||||
expect(config.plugins.length).to.equal(6);
|
||||
expect(config.plugins.length).to.equal(7);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -26,7 +26,10 @@ async function execute(configString) {
|
||||
const config = (await import(configPath)).default;
|
||||
await buildAndWrite(config);
|
||||
|
||||
return async (fileName, { stripToBody = false, stripStartEndWhitespace = true } = {}) => {
|
||||
return async (
|
||||
fileName,
|
||||
{ stripServiceWorker = false, stripToBody = false, stripStartEndWhitespace = true } = {},
|
||||
) => {
|
||||
let text = await fs.promises.readFile(
|
||||
path.join(config.output.dir, fileName.split('/').join(path.sep)),
|
||||
);
|
||||
@@ -36,6 +39,11 @@ 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();
|
||||
}
|
||||
@@ -49,26 +57,25 @@ 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 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>',
|
||||
);
|
||||
const serviceWorkerJs = await readOutput('service-worker.js');
|
||||
expect(serviceWorkerJs).to.include('Promise'); // not empty string might be enough...
|
||||
});
|
||||
});
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user