Skip to content

Commit 40cebfb

Browse files
Updated MDX files to make all titles sentence case (#709)
1 parent 23af1fa commit 40cebfb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+82
-82
lines changed

src/routes/advanced-concepts/fine-grained-reactivity.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Fine-Grained Reactivity
2+
title: Fine-grained reactivity
33
---
44

55
Reactivity ensures automatic responses to data changes, eliminating the need for manual updates to the user interface (UI).
@@ -15,7 +15,7 @@ Through targeting only the areas of an application that have changed the user ex
1515

1616
**Note:** If you're new to the concept of reactivity and want to learn the basics, consider starting with our [intro to reactivity guide](/concepts/intro-to-reactivity).
1717

18-
## Reactive Primitives
18+
## Reactive primitives
1919

2020
In Solid's reactivity system, there are two key elements: signals and observers.
2121
These core elements serve as the foundation for more specialized reactive features:

src/routes/concepts/components/basics.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ To simplify conditional rendering, Solid provides built-in [control-flow](/conce
176176
For components to be reusable, they need to be exported from one module and imported into another.
177177
This allows for components to be shared and used where needed.
178178

179-
### Exporting Components
179+
### Exporting components
180180

181181
Once defined, a component can be [exported](https://developer.mozilla.org/en-US/docs/web/javascript/reference/statements/export) to make it available for use in other parts of your application.
182182
There are two ways to export a component: [named exports](https://developer.mozilla.org/en-US/docs/web/javascript/reference/statements/export#named_exports) and [default exports](https://developer.mozilla.org/en-US/docs/web/javascript/reference/statements/export#default_exports).
@@ -212,7 +212,7 @@ export default function MyComponent() {
212212
}
213213
```
214214

215-
### Importing Components
215+
### Importing components
216216

217217
To use a component in another file or component, it must be [imported](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import).
218218
To import a component, you must specify the path to the file containing the component and the name of the component to import.

src/routes/concepts/components/class-style.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
title: Class and Style
2+
title: Class and style
33
order: 2
44
---
55

66
Similar to HTML, Solid uses `class` and `style` attributes to style elements via [CSS (Cascading Style Sheets)](https://developer.mozilla.org/en-US/docs/Glossary/CSS).
77

8-
- **Class Attribute**: Enables styling one or more elements through CSS rules.
9-
- **Style Attribute**: Inline styles that style single elements.
8+
- **Class attribute**: Enables styling one or more elements through CSS rules.
9+
- **Style attribute**: Inline styles that style single elements.
1010

1111
## Inline styling
1212

src/routes/concepts/components/event-handlers.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Event Handlers
2+
title: Event handlers
33
order: 3
44
---
55

@@ -58,7 +58,7 @@ In this example, the `Hello!` string is passed as the `data` parameter in the `h
5858

5959
By binding events in this way, Solid avoids the overhead of using JavaScript's [bind](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_objects/Function/bind) method and adding an additional closure.
6060

61-
### Dynamic Handlers
61+
### Dynamic handlers
6262

6363
An event handler does not form part of the reactive system.
6464
If you were to pass the handler as a signal, it will not respond to the changes of that signal.
@@ -190,7 +190,7 @@ button
190190

191191
</Callout>
192192

193-
### List of Delegated Events
193+
### List of delegated events
194194

195195
You can also view this list in our [source code](https://github.com/ryansolid/dom-expressions/blob/main/packages/dom-expressions/src/constants.js) (see `DelegatedEvents`).
196196

src/routes/concepts/control-flow/conditional-rendering.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Conditional Rendering"
2+
title: "Conditional rendering"
33
order: 1
44
---
55

src/routes/concepts/control-flow/list-rendering.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "List Rendering"
2+
title: "List rendering"
33
order: 3
44
---
55

src/routes/concepts/intro-to-reactivity.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Intro to Reactivity"
2+
title: "Intro to reactivity"
33
order: 1
44
---
55

src/routes/configuration/environment-variables.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Environment Variables
2+
title: Environment variables
33
---
44

55
Solid is built on top of [Vite](https://vitejs.dev/), which offers a convenient way to handle environment variables.

src/routes/guides/complex-state-management.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Complex State Management
2+
title: Complex state management
33
order: 5
44
---
55

src/routes/guides/deploying-your-app.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Deploying your App
2+
title: Deploying your app
33
order: 6
44
---
55

src/routes/guides/deployment-options/netlify.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import { TabsCodeBlocks } from "~/ui/tab-code-blocks";
99
[Netlify](https://www.netlify.com/) is a widely-used hosting platform suitable for various types of projects.
1010
For detailed guidance on build procedures, deployment options, and the range of features available, you can visit the [Netlify documentation](https://docs.netlify.com/).
1111

12-
## Using the Netlify Web Interface
12+
## Using the Netlify web interface
1313

1414
1. Begin by navigating to [Netlify's website](https://app.netlify.com/) and logging in or creating a new Netlify.
1515
Once logged in, you will be take to your dashboard. Click the `New site from Git` button to start a new project.

src/routes/guides/deployment-options/railway.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Below is an example of how your `package.json` may be configured:
3030
},
3131
```
3232

33-
## Using the Railway Web Interface
33+
## Using the Railway web interface
3434

3535
1. Visit Railway's homepage and click "Start a New Project."
3636
You will be redirected to connect with GitHub.

src/routes/guides/deployment-options/vercel.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import { TabsCodeBlocks } from "~/ui/tab-code-blocks";
99
[Vercel](https://vercel.com/) is a widely-used platform specialized in hosting frontend projects.
1010
For detailed information regarding build and deployment instructions, as well as features they offer, please visit the [Vercel documentation](https://vercel.com/docs).
1111

12-
## Using Vercel Web Interface
12+
## Using Vercel web interface
1313

1414
1. Navigate to [vercel.com/login](https://vercel.com/login) to log in or create a new account.
1515
Connect with your preferred Git repository hosting service.

src/routes/guides/fetching-data.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Fetching Data
2+
title: Fetching data
33
order: 3
44
---
55

src/routes/guides/routing-and-navigation.mdx

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
2-
title: Routing & Navigation
2+
title: Routing & navigation
33
order: 4
44
---
55

66
import { TabsCodeBlocks } from "~/ui/tab-code-blocks";
77

88
[Solid Router](/solid-router) simplifies routing in Solid applications to help developers manage navigation and rendering by defining routes using JSX or objects passed via props.
99

10-
## Getting Started
10+
## Getting started
1111

12-
**1. Install the Router**
12+
**1. Install the router**
1313

1414
This package is not included by default.
1515

@@ -48,7 +48,7 @@ render(
4848
```
4949

5050

51-
**3. Provide a Root Level Layout**
51+
**3. Provide a root level layout**
5252

5353
This layout will not update on page change and is the ideal place for top-level navigation and [Context Providers](/concepts/context).
5454

@@ -95,7 +95,7 @@ render(() => (
9595
), document.getElementById("root"));
9696
```
9797

98-
**5. Create a CatchAll Route (404 page)**
98+
**5. Create a CatchAll route (404 page)**
9999

100100
A catchall route can be used for pages not found at any nested level of the router.
101101
Using `*` will retrieve the rest of the path.
@@ -125,7 +125,7 @@ render(() => (
125125
), document.getElementById("root"));
126126
```
127127

128-
**6. Create Links to Your Routes**
128+
**6. Create links to your routes**
129129

130130
The [`<A>`](/solid-router/reference/components/a) component provides navigation to an application's routes.
131131
Alternatively, you can use the [native anchor tag](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a).
@@ -159,7 +159,7 @@ render(() => (
159159
), document.getElementById("root"));
160160
```
161161

162-
## Lazy-loading Route Components
162+
## Lazy-loading route components
163163

164164
The [`lazy`](/reference/component-apis/lazy) function postpones the loading of a component until it is navigated to.
165165

@@ -186,7 +186,7 @@ render(() => (
186186
), document.getElementById("root"));
187187
```
188188

189-
## Dynamic Routes
189+
## Dynamic routes
190190

191191
If a path is unknown ahead of time, you can treat part of the path as a flexible parameter.
192192

@@ -211,7 +211,7 @@ The colon indicates that `id` can be any string, and as long as the URL fits tha
211211

212212
You can then access that `id` from within a route component with [`useParams`](/solid-router/reference/primitives/use-params).
213213

214-
**Note on Animation/Transitions**:
214+
**Note on animation/transitions**:
215215
Routes that share the same path will be treated as the same route.
216216
If you want to force re-render, you can wrap your component in a keyed [`<Show>`](/reference/components/show):
217217

@@ -275,7 +275,7 @@ const User = () => {
275275
Every time the `id` parameter changes in this example, the `fetchUser` function is called to fetch the new user data.
276276

277277

278-
### Validating Routes
278+
### Validating routes
279279

280280
Each path parameter can be validated using a `MatchFilter`.
281281
Instead of checking for the presence of a parameter, this allows for more complex routing descriptions:
@@ -317,7 +317,7 @@ In this example:
317317
- `/users/mom/me/contact.html` will **not** match as `:id` is not a number,
318318
- `/users/dad/123/contact` will **not** match as `:withHtmlExtension` is missing `.html`.
319319

320-
### Optional Parameters
320+
### Optional parameters
321321

322322
Parameters can be specified as optional by adding a question mark to the end of the parameter name:
323323

@@ -326,7 +326,7 @@ Parameters can be specified as optional by adding a question mark to the end of
326326
<Route path="/stories/:id?" component={Stories} />
327327
```
328328

329-
### Wildcard Routes
329+
### Wildcard routes
330330

331331
To match any descendent routes within a given path, you can use the wildcard token (`*`).
332332
This can be used to represent any value in that segment of the path.
@@ -344,7 +344,7 @@ To expose the wildcard portion to the component as a parameter, you can name it:
344344

345345
Wildcard tokens **must** be the last part of the path; `foo/*any/bar` will not create any routes.
346346

347-
### Multiple Paths
347+
### Multiple paths
348348

349349
The `Routes` component also supports defining multiple paths using an array.
350350
This allows avoids a route rerendering when switching between two or more locations that it matches:
@@ -354,7 +354,7 @@ This allows avoids a route rerendering when switching between two or more locati
354354
<Route path={["login", "register"]} component={Login} />
355355
```
356356

357-
## Nested Routes
357+
## Nested routes
358358

359359
Only leaf `<Route>` nodes (the innermost `<Route>` components) are given a route.
360360

@@ -436,7 +436,7 @@ This example will only render the route `/layer1/layer2`, which will be nested i
436436
</Route>
437437
```
438438

439-
## Load Functions
439+
## Load functions
440440

441441
With load functions, data fetching is started parallel to loading the route, so it can be used as soon as possible.
442442
The load function prevents this by being called once the Route is loaded, or eagerly if links are hovered.

src/routes/guides/state-management.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: State Management
2+
title: State management
33
order: 2
44
---
55

src/routes/guides/styling-components/css-modules.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: CSS Modules
2+
title: CSS modules
33
order: 3
44
mainNavExclude: true
55
---

src/routes/guides/styling-your-components.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
2-
title: Styling your Components
2+
title: Styling your components
33
order: 1
44
---
55

66
Solid provides flexible and versatile ways to style your components.
77
[`class` and `style` bindings](/concepts/components/class-style) can both be added to dynamically style components with plain CSS.
88
Solid also supports a range of styling methods - from traditional CSS preprocessors to modern CSS-in-JS solutions - ensuring the flexibility to choose the best approach for your projects.
99

10-
## CSS Preprocessors
10+
## CSS preprocessors
1111

1212
<div class="flex flex-col md:grid md:grid-cols-2 md:grid-rows-1 gap-3">
1313

src/routes/pt-br/quick-start.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Começo Rápido
2+
title: Começo rápido
33
---
44

55
## Solid playgrounds

src/routes/pt-br/solid-router/quick-start.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Começo Rápido
2+
title: Começo rápido
33
---
44

55
## Solid playgrounds

src/routes/quick-start.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Quick Start
2+
title: Quick start
33
---
44

55
## Solid playgrounds

src/routes/reference/basic-reactivity/create-resource.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ This can be useful if you want to show the out-of-date data while the new data i
7979

8080
`loading`, `error`, and `latest` are reactive getters and can be tracked.
8181

82-
## The Fetcher
82+
## The fetcher
8383

8484
The `fetcher` is the async function that you provide to `createResource` to actually fetch the data.
8585
It is passed two arguments: the value of the source signal (if provided), and an info object with two properties: `value` and `refetching`.

src/routes/reference/components/suspense.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ const MyComponent = () => {
4747

4848
```
4949

50-
## The Purpose of {"<Suspense>"}
50+
## The purpose of {"<Suspense>"}
5151

5252
To understand the purpose of suspense, let's consider the following code snippets. These snippets will have some drawbacks which we will solve by using suspense. We will also see how it is possible to use suspense yet not reap its benefits.
5353

src/routes/reference/reactive-utilities/on.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ createEffect(
5959
setState({ a: 4 }); // logs 4
6060
```
6161

62-
## Arguments and Options
62+
## Arguments and options
6363

6464
| Argument | Type | Description |
6565
| :------- | :--------------------------------------------- | :------------------------------------------------ |

src/routes/reference/store-utilities/create-store.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,4 +85,4 @@ setState((state) => ({ preferredName: state.firstName, lastName: "Milner" }));
8585

8686
---
8787

88-
To learn more about using stores check the [Stores Guide](/concepts/stores), and the **Store Utilities** section for more advanced APIs.
88+
To learn more about using stores check the [Stores Guide](/concepts/stores), and the **Store utilities** section for more advanced APIs.

src/routes/solid-router/concepts/actions.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ export function MyComponent() {
109109
}
110110
```
111111

112-
## Server Actions
112+
## Server actions
113113

114114
Sometimes we need to make sure our action _only_ runs on the server. This is useful for:
115115

@@ -145,7 +145,7 @@ export function MyComponent() {
145145
}
146146
```
147147

148-
## Error Handling
148+
## Error handling
149149

150150
We strongly recommend with actions to "return" errors rather than throwing them. This can help with typing of submissions you'd use with `useSubmission`. This is important especially for handling progressive enhancement where no JS is present in the client so that we can use the error declaratively to render the updated page on the server.
151151

0 commit comments

Comments
 (0)