From f4d225a92a334c69f136203482783dfd6636bef9 Mon Sep 17 00:00:00 2001 From: Owen Buckley Date: Fri, 11 Feb 2022 19:28:45 -0500 Subject: [PATCH] Website/issue 503 copy and content updates for ssr (#877) * home page and banner copy updates * about page updates and revisions * update and revisit docs pages * update and revisit getting started pages * refreah plugins and guides pages * big round of spellchecking * underline and darken home page links * spellcheck package READMEs * update project description in packages and README, and meta * add link on static and server rendering stratigies and remove extra plugin from docs greenwood config * update project README content --- README.md | 2 +- greenwood.config.js | 6 ++--- package.json | 2 +- packages/cli/src/lifecycles/config.js | 2 +- packages/plugin-babel/README.md | 4 ++-- packages/plugin-google-analytics/README.md | 12 +++++----- packages/plugin-graphql/README.md | 6 ++--- packages/plugin-import-commonjs/README.md | 2 +- packages/plugin-import-css/README.md | 4 ++-- packages/plugin-include-html/README.md | 18 +++++++------- packages/plugin-polyfills/README.md | 2 +- packages/plugin-postcss/README.md | 6 ++--- packages/plugin-renderer-lit/README.md | 8 +++---- packages/plugin-typescript/README.md | 6 ++--- www/components/banner/banner.js | 6 ++--- www/pages/about/community.md | 5 ++-- www/pages/about/features.md | 11 ++++----- www/pages/about/goals.md | 12 ++++++---- www/pages/about/how-it-works.md | 23 +++++++++--------- www/pages/about/index.md | 5 ++-- www/pages/blog/release/v0-18-0.md | 4 ++-- www/pages/blog/release/v0-19-0.md | 18 +++++++------- www/pages/blog/release/v0-20-0.md | 4 ++-- www/pages/docs/component-model.md | 10 ++++---- www/pages/docs/configuration.md | 16 ++++++------- www/pages/docs/css-and-images.md | 2 +- www/pages/docs/data.md | 13 +++++----- www/pages/docs/front-matter.md | 4 ++-- www/pages/docs/index.md | 6 ++--- www/pages/docs/layouts.md | 24 +++++++++---------- www/pages/docs/server-rendering.md | 14 +++++------ www/pages/docs/tech-stack.md | 10 ++++---- www/pages/getting-started/creating-content.md | 2 +- www/pages/getting-started/index.md | 8 +++---- www/pages/getting-started/key-concepts.md | 6 ++--- www/pages/getting-started/next-steps.md | 2 +- www/pages/getting-started/project-setup.md | 4 ++-- www/pages/getting-started/quick-start.md | 6 ++--- .../guides/cloudflare-workers-deployment.md | 2 +- www/pages/guides/firebase.md | 4 ++-- www/pages/guides/github-pages.md | 2 +- www/pages/guides/index.md | 2 +- www/pages/guides/netlify-cms.md | 6 ++--- www/pages/guides/now.md | 2 +- www/pages/guides/s3-cloudfront.md | 2 +- www/pages/guides/theme-packs.md | 18 +++++++------- www/pages/index.html | 8 +++---- www/pages/plugins/context.md | 14 +++++------ www/pages/plugins/custom-plugins.md | 4 ++-- www/pages/plugins/index.md | 6 ++--- www/pages/plugins/resource.md | 6 ++--- www/pages/plugins/server.md | 2 +- www/styles/home.css | 3 ++- 53 files changed, 188 insertions(+), 188 deletions(-) diff --git a/README.md b/README.md index ca1372a17..86d3a5e93 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ [![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/) ## Overview -Greenwood is a modern and performant static site generator supporting Web Component based development. For more information about how to get started, read our docs, or learn more about the project and how it works, please visit our [website](https://www.greenwoodjs.io/). +Greenwood is a framework focused on supporting modern web standards and development to help you build your next project. For more information about how to get started, read our docs, or learn more about the project and how it works, please visit our [website](https://www.greenwoodjs.io/). Features: - ⚡ [No bundle development](https://www.greenwoodjs.io/about/how-it-works/). Pages are built on the fly. diff --git a/greenwood.config.js b/greenwood.config.js index 5f8a8a6c6..1df102cac 100644 --- a/greenwood.config.js +++ b/greenwood.config.js @@ -4,11 +4,10 @@ import { greenwoodPluginImportCss } from '@greenwood/plugin-import-css'; import { greenwoodPluginImportJson } from '@greenwood/plugin-import-json'; import { greenwoodPluginPolyfills } from '@greenwood/plugin-polyfills'; import { greenwoodPluginPostCss } from '@greenwood/plugin-postcss'; -import { greenwoodPluginRendererLit } from '@greenwood/plugin-renderer-lit'; import rollupPluginAnalyzer from 'rollup-plugin-analyzer'; import { fileURLToPath, URL } from 'url'; -const META_DESCRIPTION = 'A modern and performant static site generator supporting Web Component based development'; +const META_DESCRIPTION = 'A modern framework focused on web standards to help you build your next project.'; const FAVICON_HREF = '/favicon.ico'; export default { @@ -47,8 +46,7 @@ export default { ]; } }, - ...greenwoodPluginIncludeHTML(), - greenwoodPluginRendererLit() + ...greenwoodPluginIncludeHTML() ], markdown: { plugins: [ diff --git a/package.json b/package.json index 6847cb112..2ea9be76c 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "greenwood", "private": true, - "description": "A modern and performant static site generator supporting Web Component based development.", + "description": "A modern framework focused on web standards to help you build your next project.", "repository": "https://github.com/ProjectEvergreen/greenwood", "author": "Owen Buckley ", "license": "MIT", diff --git a/packages/cli/src/lifecycles/config.js b/packages/cli/src/lifecycles/config.js index f675db552..1154fb447 100644 --- a/packages/cli/src/lifecycles/config.js +++ b/packages/cli/src/lifecycles/config.js @@ -83,7 +83,7 @@ const readAndMergeConfig = async() => { 'common issues to check might be: \n' + '- typo in your workspace directory name, or in greenwood.config.js \n' + '- if using relative paths, make sure your workspace is in the same cwd as _greenwood.config.js_ \n' + - '- consider using an absolute path, e.g. path.join(__dirname, \'my\', \'custom\', \'path\') // <__dirname>/my/custom/path/ '); + '- consider using an absolute path, e.g. new URL(\'/your/relative/path/\', import.meta.url)'); } } diff --git a/packages/plugin-babel/README.md b/packages/plugin-babel/README.md index 27d68e96d..d032c4e66 100644 --- a/packages/plugin-babel/README.md +++ b/packages/plugin-babel/README.md @@ -43,12 +43,12 @@ module.exports = { }; ``` -This will then process your JavaScript with Babel with the configurated plugins / settings you provide. +This will then process your JavaScript with Babel using the configured plugins and settings you provide. > _For now Babel configuration needs to be in CJS. Will we be adding ESM support soon!_ ## Options -This plugin provides a default _babel.config.js_ that includes support for [**@babel/preset-env**](https://babeljs.io/docs/en/babel-preset-env) using [**browserslist**](https://github.com/browserslist/browserslist) with reasonable [default configs](https://github.com/ProjectEvergreen/greenwood/tree/master/packages/plugin-babel/src/) for each. +This plugin provides a default _babel.config.js_ that includes support for [**@babel/preset-env**](https://babeljs.io/docs/en/babel-preset-env) using [**browserslist**](https://github.com/browserslist/browserslist) with reasonable [default configs](https://github.com/ProjectEvergreen/greenwood/tree/master/packages/plugin-babel/src/) for each. If you would like to use it, either standalone or with your own custom _babel.config.js_, you will need to take the following extra steps: diff --git a/packages/plugin-google-analytics/README.md b/packages/plugin-google-analytics/README.md index cdb7f1826..999a2fa4e 100644 --- a/packages/plugin-google-analytics/README.md +++ b/packages/plugin-google-analytics/README.md @@ -1,12 +1,12 @@ # @greenwood/plugin-google-analytics ## Overview -A Greenwood plugin adding support for [Google Analytics](https://developers.google.com/analytics/) JavaScript tracker. It assumes you already have your own Tracking ID(s) and [can eiterh filter out tracking for everything but your production environment](https://stackoverflow.com/a/1251931/417806) so that local testing doesn't interfere with production data, or use a conditional based `analyticsId` using an environment variable, ex. +A Greenwood plugin adding support for [Google Analytics](https://developers.google.com/analytics/) JavaScript tracker. It assumes you already have your own Tracking ID(s) and [can either filter out tracking for everything but your production environment](https://stackoverflow.com/a/1251931/417806) so that local testing doesn't interfere with production data, or use a conditional based `analyticsId` using an environment variable, ex. ```js const analyticsId = process.env.NODE_ENV === 'xxx' ? 'UA-123...' : 'UA-345...'; ``` -> _For more information and complete docs about Greenwood, please visit the [Greenwood website](https://www.greenwoodjs.io/)._ +> _For more information and complete docs about Greenwood, please visit the [Greenwood website](https://www.greenwoodjs.io/)._ ## Installation @@ -49,14 +49,14 @@ This will then add the Google Analytics [JavaScript tracker snippet](https://dev - `anonymous` (optional) - Sets if tracking of IPs should be done anonymously. Default is `true` ### Outbound Links -For links that go outside of your domain, the global function [`getOutboundLink`](https://support.google.com/analytics/answer/7478520) is available for you to use. +For links that go outside of your domain, the global function [`getOutboundLink`](https://support.google.com/analytics/answer/7478520) is available for you to use. Example: ```html -My Link ``` \ No newline at end of file diff --git a/packages/plugin-graphql/README.md b/packages/plugin-graphql/README.md index ddd2583cc..7dfd077a0 100644 --- a/packages/plugin-graphql/README.md +++ b/packages/plugin-graphql/README.md @@ -1,4 +1,4 @@ -# @greenwood/plugin-graphl +# @greenwood/plugin-graphql ## Overview A plugin for Greenwood to support using [GraphQL](https://graphql.org/) to query your content graph. It runs [**apollo-server**](https://www.apollographql.com/docs/apollo-server/) on the backend and provides an [**@apollo/client** like](https://www.apollographql.com/docs/react/api/core/ApolloClient/#ApolloClient.readQuery) interface for the frontend. @@ -48,7 +48,7 @@ class HeaderComponent extends HTMLElement { connectedCallback() { const response = await client.query({ - query: MenuQuery, + query: MenuQuery, variables: { name: 'navigation', order: 'index_asc' @@ -67,7 +67,7 @@ class HeaderComponent extends HTMLElement { `; }).join(); - + return `