Skip to content

Commit

Permalink
docs: fix spelling (#1983)
Browse files Browse the repository at this point in the history
Co-authored-by: Romuald Brillout <git@brillout.com>
  • Loading branch information
cr7pt0gr4ph7 and brillout authored Nov 23, 2024
1 parent 7f41ba2 commit 5d2f02d
Show file tree
Hide file tree
Showing 20 changed files with 28 additions and 28 deletions.
2 changes: 1 addition & 1 deletion docs/pages/Head/+Page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ The `<Head>` component is only used when rendering the HTML of the first page th
### Limitation
The most notable limitation is that the `+Head` setting cannot be used to set the `<title>` value, because the title isn't updated when navigating to a page with a different tilte.
The most notable limitation is that the `+Head` setting cannot be used to set the `<title>` value, because the title isn't updated when navigating to a page with a different title.
> See <Link href="#example">example below</Link> for a more detailed explanation.
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/build-your-own-framework/+Page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Vike enables you to create your own framework tailored to your company's require

> It's a powerful way to scale your teams, and to ensure a cohesive stack throughout your company. See <Link href="/why#build-your-own-framework" />.
Your framework can include everything (frontend, backend, data fetching, authentication, deployement, error tracking, analytics, ...) so that your Product Developers can focus on what they do best: building user interfaces.
Your framework can include everything (frontend, backend, data fetching, authentication, deployment, error tracking, analytics, ...) so that your Product Developers can focus on what they do best: building user interfaces.


## Getting started
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/cloudflare-pages/+Page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The [vike-cloudflare](https://github.com/vikejs/vike-cloudflare) package enables

It will deploy prerendered routes as static files, and dynamic routes as [Pages Functions](https://developers.cloudflare.com/pages/functions/advanced-mode/).

> Instead of using `vike-cloudflare` you can manally integrate Cloudflare Pages yourself, see <Link href="/cloudflare-workers#cloudflare-pages" doNotInferSectionTitle={true} />.
> Instead of using `vike-cloudflare` you can manually integrate Cloudflare Pages yourself, see <Link href="/cloudflare-workers#cloudflare-pages" doNotInferSectionTitle={true} />.
### Without a server

Expand Down
4 changes: 2 additions & 2 deletions docs/pages/eject/+Page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { UiFrameworkExtension } from '../../components'

The [eject package](https://github.com/snake-py/eject) enables you to take control of Vike extensions.

<Construction>The eject pacakge is [work-in-progress](https://github.com/snake-py/eject/issues/7#issuecomment-2480853337).</Construction>
<Construction>The eject package is [work-in-progress](https://github.com/snake-py/eject/issues/7#issuecomment-2480853337).</Construction>

It moves the code of the extension from `/node_modules/vike-some-extension/` to your Git repository at `/ejected/vike-some-extension/`. This means you can then fully modify the code of `vike-some-extension`.

Expand All @@ -13,7 +13,7 @@ It moves the code of the extension from `/node_modules/vike-some-extension/` to
## When to eject?

In genreal, before considering ejection, we recommend reaching out to the maintainer of the Vike extension and to consider making a Pull Request.
In general, before considering ejection, we recommend reaching out to the maintainer of the Vike extension and to consider making a Pull Request.

Only eject as a last resort &mdash; when it's clear that it's the only option.

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/error-tracking/+Page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ You can use <Link href="/client">`+client.js`</Link> in order to make sure that
```js
// pages/+client.js

// This is a good place to initialize an error tracker scuh as Sentry
// This is a good place to initialize an error tracker such as Sentry
Sentry.init()

// Custom tracking
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/escapeInject/+Page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { Link, RepoLink } from '@brillout/docpress'

Environment: server.

The `escapeInject` string template tag sanitizes HTML to prevent security risks commmonly called [XSS injections](https://en.wikipedia.org/wiki/Cross-site_scripting).
The `escapeInject` string template tag sanitizes HTML to prevent security risks commonly called [XSS injections](https://en.wikipedia.org/wiki/Cross-site_scripting).

> If you use a <UiFrameworkExtension />, then you don't need to use `escapeInject` yourself as <UiFrameworkExtension name noLink /> already sanitizes its HTML.
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/index/Header.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ function VikeNitedaniAnimated() {
useEffect(() => {
// Avoid loading the video on mobile:
// - To save KBs.
// - To avoid weird mobile iOS Chrome bug(?): the video is automatically shown fullscren when client-side navigating from another page to the landing page.
// - To avoid weird mobile iOS Chrome bug(?): the video is automatically shown fullscreen when client-side navigating from another page to the landing page.
// 759 => same as https://github.com/vikejs/vike/blob/2c6325615390ae3be3afc6aa37ede6914b935702/docs/pages/index/HeaderLayout.css#L24
if (screen.width > 759) {
const videoEl = ref.current!
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/index/sponsorsList.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ const sponsorsList: Sponsor[] = [
github: 'OptimizersGroup'
},
{
companyName: 'BurdaFoward',
companyName: 'BurdaForward',
companyLogo: burdaforwardLogo,
plan: 'bronze',
website: 'https://www.burda-forward.de',
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/integration/+Page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ You can also load and/or initialize analytics code only after the hydration ends

## Component libraries

Some compnent libraries need initialization, most notably vanilla component libraries such as Bootstrap.
Some component libraries need initialization, most notably vanilla component libraries such as Bootstrap.

To initialize code, you can use
- <Link href="/onHydrationEnd" noBreadcrumb/>
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/onBeforeRender/+Page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ export default { modelName: 'User', select: ['firstName', 'lastName'] }
export default { modelName: 'Product', select: ['name', 'price'] }
```

A single global `onBeforeRender()` hook orchestrating the customm setting:
A single global `onBeforeRender()` hook orchestrating the custom setting:

```js
// /pages/+onBeforeRender.js
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/prefetchStaticAssets/+Page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export default {
}
```

> Viewport prefetching is disabled in development. (Because preloading pages that eargly <ViteLazyTranspilingContradiction />.)
> Viewport prefetching is disabled in development. (Because preloading pages that early <ViteLazyTranspilingContradiction />.)
> Only static assets are prefetched: the `pageContext` of pages isn't prefetched, see [#246](https://github.com/vikejs/vike/issues/246).
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/react/+Page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Instead of using <Link href="/vike-react">`vike-react`</Link>, you can implement
Official examples:
- <Link href="/boilerplates/boilerplate-react-ts" /> - Classic integration, using <Link href="/client-routing">Client Routing</Link>.
- <Link href="/examples/react-minimal" /> - Minimalistic integration, using <Link href="/server-routing">Server Routing</Link>.
- [`vike-react` source code](https://github.com/vikejs/vike-react/tree/main/packages/vike-react) - Full-featured integeration.
- [`vike-react` source code](https://github.com/vikejs/vike-react/tree/main/packages/vike-react) - Full-featured integration.
- <Link href="/examples/render-modes" /> - Integration supporting all <Link href="/render-modes">render modes</Link> (SSR, SPA, and HTML-only).

> For more official examples, see [GitHub > `vikejs/vike` > `examples/`](https://github.com/vikejs/vike/tree/main/examples).
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/require/+Page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { Link } from '@brillout/docpress'
The `require` setting enable a <Link href="/extensions">Vike extension</Link> to declare its dependency on other Vike extensions and enforce users to install these.

```js
// /node_mdolues/vike-react-query/dist/+config.js
// /node_modules/vike-react-query/dist/+config.js

export default {
name: 'vike-react-query'
Expand Down
6 changes: 3 additions & 3 deletions docs/pages/servers/+Page.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { Link } from '@brillout/docpress'
import { JustAMiddleware } from '../../components'

You can embed Vike into any server, and use any server utilitiy.
You can embed Vike into any server, and use any server utility.

> Alternatively, instead of using a server, you can <Link href="/pre-rendering">pre-render</Link> your pages and deploy to a <Link href="/static-hosts">static host</Link>.
Expand Down Expand Up @@ -35,7 +35,7 @@ You can use Vike with a non-JavaScript backend using following setup:

> If you want SSR, then you need to deploy two server runtimes: your non-JavaScript runtime as well as a JavaScript server runtime (Node.js/Deno/Bun).
>
> Alternatively, instead of using a server JavaScript runtime, you can <Link href="/pre-redenring">pre-render</Link> your pages while <Link href="/ssr">disabling SSR</Link>. In other words: you generate empty HTML shells that you statically deploy (using a <Link href="/static-hosts">static host</Link> or your own static assets deployment).
> Alternatively, instead of using a server JavaScript runtime, you can <Link href="/pre-rendering">pre-render</Link> your pages while <Link href="/ssr">disabling SSR</Link>. In other words: you generate empty HTML shells that you statically deploy (using a <Link href="/static-hosts">static host</Link> or your own static assets deployment).
> The HTML must be generated by Vike because the UI is *completely* owned by React/Vue/Solid. You cannot generate the HTML using your non-JavaScript backend: React/Vue/Solid would <Link href="/hydration-mismatch">complain that it doesn't match</Link> and completely erase your HTML.
Expand All @@ -47,7 +47,7 @@ That way, you can use Vike with any backend:
- Elixir (Phoenix, ...)
- Go (Gin, Echo, Fiber, ...)
- Rust (Actix Web, Rocket, ...)
- Backend-as-a-Service (Firbase, ..)
- Backend-as-a-Service (Firebase, ..)
- ...

Example:
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/solid/+Page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Instead of using <Link href="/vike-solid">`vike-solid`</Link>, you can implement
<CustomIntegrationWarning list={['vike-solid']} />

Official example:
- [`vike-solid` source code](https://github.com/vikejs/vike-solid/tree/main/vike-solid) - Full-featured integeration.
- [`vike-solid` source code](https://github.com/vikejs/vike-solid/tree/main/vike-solid) - Full-featured integration.

Community examples:
- <Example timestamp="2024.01" repo="birkskyum/vike-with-solid-ssr" /> - Solid + SSR + Client Routing.
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/static-directory/+Page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ dist/client/robots.txt
```

Note how Vite:
- Adds the content hash `b0c3b30b` for improved cachability.
- Adds the content hash `b0c3b30b` for improved cacheability.
- Copies all files living under `public/` to `dist/client/`.

## Server static middleware
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/stores/+Page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ In principle, you can use Vike with any store.
- <Link href="/vuex" />
- <Link href="/examples#stores">... more</Link>

The documention on this page is about manually integrating stores.
The documentation on this page is about manually integrating stores.

<Advanced>
Instead of manually integrating stores, we generally recommend using <Link href="/extensions">Vike extensions</Link> such as [`vike-vue-pinia`](https://github.com/vikejs/vike-vue/tree/main/packages/vike-vue-pinia#readme).
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/useConfig/+Page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Environment: server, client.

The `useConfig()` hook enables you to set configurations inside UI components, as well as inside Vike hooks such as <Link href="/data">`+data`</Link>.

> This hook is unusual because it can also be used inside Vike hooks. We call it a *universal hook*. So far `useConfig()` is the only unviversal hook.
> This hook is unusual because it can also be used inside Vike hooks. We call it a *universal hook*. So far `useConfig()` is the only universal hook.
It currently supports following configs:
- <Link href="/Head" noBreadcrumb />
Expand Down Expand Up @@ -109,7 +109,7 @@ function Movies() {
> Both achieve the same:
> - `<Head><something/></Head>`
> - `<Config Head={<something/>}/>`
>
>
> There in't a `<Title>` component because it's expected to be a string: e.g. `<Title><span>hello</span></Title>` doesn't make sense.

Expand Down
4 changes: 2 additions & 2 deletions docs/pages/vercel/+Page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Link, Warning } from '@brillout/docpress'
import { UseBati } from '../../components'
import { Example } from '../../components'

You can deploy Vike to [Vercel](https://vercel.com) simply by using a Vercel API Route. Alternatively, you can use `vite-plugin-vercel` for a full-fleged Vercel integration with ISR and Edge Middlewares.
You can deploy Vike to [Vercel](https://vercel.com) simply by using a Vercel API Route. Alternatively, you can use `vite-plugin-vercel` for a full-fledged Vercel integration with ISR and Edge Middlewares.

We recommend using the Vercel API Route technique because it's a simple and sturdy integration. Later, if the need arises, you can switch to `vite-plugin-vercel`.

Expand All @@ -13,7 +13,7 @@ We recommend using the Vercel API Route technique because it's a simple and stur

You can integrate Vercel simply by creating a Vercel API Route `api/ssr.js` that server-side renders your app.

Example:
Example:
- <Example timestamp="2024.03" repo="brillout/vike-with-vercel" />
<Warning>Make sure to properly set `OUTPUT DIRECTORY` in your Vercel dashboard, see the example's `README.md` instructions.</Warning>

Expand Down
8 changes: 4 additions & 4 deletions docs/pages/why/+Page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ For example, Vike's low-level hooks <Link href="/onRenderHtml">`onRenderHtml()`<
Another example is Vike's server middleware <Link href="/renderPage"><code>renderPage()</code></Link> enabling you to embed Vike into any:
- Server (Express.js, Hono, Fastify, ...)
- Deployement (AWS, Cloudflare, Vercel, ...)
- Deployment (AWS, Cloudflare, Vercel, ...)

> Alternatively, you can <Link href="/pre-rendering">pre-render your pages</Link> and deploy your app to any static host.
Expand Down Expand Up @@ -83,7 +83,7 @@ Vike is a robust foundation (Vike itself) with a thin and flexible layer (Vike e

Vike enables you to <Link href="/build-your-own-framework">build company internal frameworks</Link>, empowering your Software Architects to fully own the architecture while providing your Product Developers with a company framework to quickly experiment, iterate, and ship production-grade apps.

Your framework can include everything (frontend, backend, data fetching, authentication, deployement, error tracking, analytics, ...) so that your Product Developers can focus on what they do best: building user interfaces.
Your framework can include everything (frontend, backend, data fetching, authentication, deployment, error tracking, analytics, ...) so that your Product Developers can focus on what they do best: building user interfaces.

Vike enables you to build your own internal ecosystem of tools. It's a powerful way to scale your teams, and to ensure a cohesive stack throughout your company.

Expand All @@ -95,7 +95,7 @@ Vike enables you to build your own internal ecosystem of tools. It's a powerful
Vike is driven by core principles.


### Seperation of concerns
### Separation of concerns

Vike is carefully designed with a clean separation of concerns, for unprecedented flexibility and robustness.

Expand All @@ -104,7 +104,7 @@ Enabling you to choose architectural components independently of each other, and

### Flourishing do-one-thing-do-it-well ecosystem

Vike's seperation of concerns enables architectural components to be developed independently of each other.
Vike's separation of concerns enables architectural components to be developed independently of each other.

A vibrant ecosystem of do-one-thing-do-it-well tools that compete with each other is one of the strongest driving force behind JavaScript's success.

Expand Down

0 comments on commit 5d2f02d

Please sign in to comment.