Skip to content

Commit

Permalink
appendix docs content
Browse files Browse the repository at this point in the history
  • Loading branch information
thescientist13 committed Oct 22, 2024
1 parent 0a7fea1 commit a9c52db
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
12 changes: 6 additions & 6 deletions src/pages/docs/reference/appendix.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ tocHeading: 2

## Build Output

Greenwood produces a consistent build output that typically mirrors the source directory as it persists all file naming, albeit typically with hashed filenames. For static content, this can be used by static hosting sites with no additional configuration, on serverless hosting with our adapters, or self-hosted with Greenwood's `serve` command on your own server or in a Docker container.
Greenwood produces a consistent build output that typically mirrors the source directory as it persists all file naming, albeit typically with hashed filenames. For static content, this can be used by static hosting sites with no additional configuration, on serverless hosting with our adapters, or self-hosted with Greenwood's `serve` command on your own server or in a Docker container.

The type of output you may see from Greenwood in the output directory, depending on what features you are using, includes:

- **Static HTML** - For static and markdown pages, or SSR pages using the `prerender` option
- **Static Assets** - Images and fonts bundled from your CSS, or in the _assets/_ directory. This would also include JavaScript (`<script>`) and CSS (`<link>`) assets intended for the browser
- **Static Assets** - Images and fonts bundled from your CSS, or in the _assets/_ directory. This would also include JavaScript (`<script>`) and CSS (`<link>`) assets intended for the browser
- **SSR Page Chunk(s)** - Entry points for all dynamic pages
- **API Route Chunk(s)** - Entry points for all API routes

Expand Down Expand Up @@ -65,11 +65,11 @@ This is the current configuration state of Greenwood, which is a merger of any s

### Graph

The graph is an array of all pages in the project, as an array. You can see the [Pages Data](/docs/content-as-data/pages-data/) section under our [Content as Data docs](/docs/content-as-data/) for more information on the shape and usage options for this.
The graph is an array of all pages in the project, as an array. You can see the [Pages Data](/docs/content-as-data/pages-data/) section under our [Content as Data docs](/docs/content-as-data/) for more information on the shape and usage options for this.

### Context

The context objects provides access to all the input and output directories Greenwood uses to build the site and resolve workspace files, _node_modules_, build output directories, and more. This is especially useful to [plugins](/docs/reference/plugins-api/) as they often involve processing and manipulating files.
The context objects provides access to all the input and output directories Greenwood uses to build the site and resolve workspace files, _node_modules_, build output directories, and more. This is especially useful to [plugins](/docs/reference/plugins-api/) as they often involve processing and manipulating files.

Here are some of the most useful paths available on **context**, all of which are instances of [`URL`](https://developer.mozilla.org/en-US/docs/Web/API/URL):

Expand All @@ -83,7 +83,7 @@ Here are some of the most useful paths available on **context**, all of which ar

By default, Greenwood handles server rendering with [**WCC (Web Components Compiler)**](https://github.com/ProjectEvergreen/wcc), which brings with it a minimal DOM Shim that emulates a minimal amount of DOM and Web APIs, most as no-ops for the benefit of making SSR and prerendering a bit more ergonomic for development.

It is fine-tuned for creating Light and Shadow DOM based custom elements. Highlights include:
It is fine-tuned for creating Light and Shadow DOM based custom elements. Highlights include:

- `customElements.define`
- `attachShadow`
Expand All @@ -96,4 +96,4 @@ It is fine-tuned for creating Light and Shadow DOM based custom elements. Highl

The full list is documented [here](https://merry-caramel-524e61.netlify.app/#key-features).

> You can also customize the renderer using a plugin like our [Lit SSR renderer plugin](/docs/plugins/lit-ssr/) for Lit based projects, or [create your own renderer plugin](/docs/reference/plugins-api/#renderer).
> You can also customize the renderer using a plugin like our [Lit SSR renderer plugin](/docs/plugins/lit-ssr/) for Lit based projects, or [create your own renderer plugin](/docs/reference/plugins-api/#renderer).
2 changes: 1 addition & 1 deletion src/pages/docs/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ The content is broken down across these sections:
- [Configuration](/docs/reference/configuration/) - All of Greenwood's configuration options
- [Plugins API](/docs/reference/plugin-apis/) - Learn how to create your own plugins
- [Rendering Strategies](/docs/reference/rendering-strategies/) - Techniques and tips for various rendering options like CSR, SSR, and prerendering
- [Appendix](/docs/reference/appendix/) - Supplemental topics like Greenwood's build output, internal build state, and DOM emulation handling
- [Appendix](/docs/reference/appendix/) - Supplemental topics like Greenwood's build output, internal build state, and DOM emulation handling

0 comments on commit a9c52db

Please sign in to comment.