diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 1ade9ccd8..000000000 --- a/.travis.yml +++ /dev/null @@ -1,13 +0,0 @@ -language: node_js -node_js: - - 12 -script: npm t - -# We do not test pushes to branches, since they are redundant with the pull_request build -# for each branch. See: https://github.com/linkerd/linkerd2/blob/3be5de1736913f0a3924a1fbd968f7826b3e9a16/.travis.yml#L5-L10 -branches: - only: - - master - -notifications: - email: false diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 36546a7a0..000000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,64 +0,0 @@ -### Preact Website Update - -**Size before:** _(via [size-plugin](https://github.com/googlechromelabs/size-plugin)) - -WPT: https://www.webpagetest.org/result/181210_P8_82a008b7a17bc1c55c61197672205e93/ -LH: https://www.webpagetest.org/lighthouse.php?test=181210_P8_82a008b7a17bc1c55c61197672205e93&run=3 - -``` - a3d80eb575b803a6508e.worker.js ⏤ 216 kB - bundle.js ⏤ 33.6 kB - 1.80d97f20c0fd15d2e7c6.chunk.js ⏤ 3.21 kB - 2.f0ec73293bbbd9656786.chunk.js ⏤ 8.77 kB - repl.96b61a2ae529b974054a.chunk.js ⏤ 70.1 kB - style.css ⏤ 6.66 kB - index.html ⏤ 2.23 kB - sw.js ⏤ 10 kB (+2 B) - appcache/manifest.html ⏤ 66 B -``` - -**Size After:** - -``` - 247ee39acd39bae81efc.worker.js ⏤ 217 kB - bundle.js ⏤ 33.8 kB - 1.********************.chunk.js ⏤ 3.21 kB - 2.********************.chunk.js ⏤ 8.77 kB - repl.********************.chunk.js ⏤ 71.9 kB (+1.71 kB) - style.css ⏤ 6.66 kB - index.html ⏤ 2.23 kB - sw.js ⏤ 10 kB (-8 B) - appcache/manifest.html ⏤ 66 B -``` - -### RCA - -- bundle.js increased by 1.5kB because of marked: (+2kB to 7.2kB: https://bundlephobia.com/result?p=marked@0.5.2) -- highlight.js increased in size dramatically over the past few releases, though we're subsetting -- polyfills increased in size. switch from fetch to unfetch helped, code-splitting removed the issue entirely -- classnames increased in size a bit. it also isn't getting bundled optimally due to a nonstandard UMD wrapper -- FCP was always a bit bad since only the app shell is prerendered - -**After webpack + dep updates:** - -``` - ae1ee828a2ca1fab34e4.worker.js ⏤ 214 kB - editor.44a85.css ⏤ 2.14 kB - editor.452bc.chunk.js ⏤ 69 kB - emoji.d52cc.chunk.js ⏤ 8.75 kB - main.3b5f6.css ⏤ 6.6 kB - main.js ⏤ 29.9 kB - offline.e400f.chunk.js ⏤ 801 B - polyfills.js ⏤ 2.01 kB - repl.45b46.css ⏤ 899 B - repl.34587.chunk.js ⏤ 2.28 kB - index.html ⏤ 2.22 kB - sw.js ⏤ 10.4 kB (+2 B) - appcache/manifest.html ⏤ 86 B -``` - -| Metric | Start | Final | -|-------------|--------|--------| -| FCP | 1300ms | 1300ms | -| TTI | 5900ms | 2950ms | -| Speed Index | 2380ms | 1910ms | diff --git a/README.md b/README.md index 0ef0d4b37..9b673332d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ # Preact Documentation Website -[![Build Status](https://travis-ci.org/preactjs/preact-www.svg?branch=master)](https://travis-ci.org/preactjs/preact-www) [![Preact Slack Community](https://img.shields.io/badge/slack-Preact%20Slack%20Community-blue?logo=slack)](https://chat.preactjs.com/) Built with [preact-cli](https://github.com/preactjs/preact-cli) @@ -9,17 +8,17 @@ Built with [preact-cli](https://github.com/preactjs/preact-cli) --- -# Application Structure +## Application Structure This website is built as a [prerendered static app](https://developers.google.com/web/updates/2019/02/rendering-on-the-web#static-rendering), following the [Application Shell pattern](https://developers.google.com/web/fundamentals/architecture/app-shell). -#### Content +### Content Content is fetched and rendered on the fly from Markdown documents located in `content/`, similar to how Jekyll works. Documents can contain optional YAML FrontMatter for specifying page metadata or layout information. Once fetched, content is parsed using [marked] and rendered to VDOM via [preact-markup]. -#### Custom Elements +### Custom Elements Since [preact] is used to render the Markdown content, HTML contained in a document reference any of the Components listed in `src/components/widget.js` as Custom Elements, useful for dynamic content: @@ -32,14 +31,14 @@ Since [preact] is used to render the Markdown content, HTML contained in a docum ``` -#### Navigation +### Navigation Currently, the navigation menu and route handling is controlled by `src/config.json`. This is likely to change, but in the meantime it means any new pages must be linked from the `"nav"` section of the config. --- -# Local Development +## Local Development ### Clone & Install Dependencies @@ -50,12 +49,12 @@ cd preact-www npm install ``` -## Development Workflow +### Development Workflow **To start a live-reload development server:** ```sh -PORT=8080 npm run dev +npm run dev ``` > Any time you make changes within the `src` directory, it will rebuild and even refresh your browser.