Skip to content

Commit

Permalink
Updated MDX files to make all titles sentence case (#709)
Browse files Browse the repository at this point in the history
  • Loading branch information
LDraco-Sharif authored May 9, 2024
1 parent 23af1fa commit 40cebfb
Show file tree
Hide file tree
Showing 46 changed files with 82 additions and 82 deletions.
4 changes: 2 additions & 2 deletions src/routes/advanced-concepts/fine-grained-reactivity.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Fine-Grained Reactivity
title: Fine-grained reactivity
---

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

**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).

## Reactive Primitives
## Reactive primitives

In Solid's reactivity system, there are two key elements: signals and observers.
These core elements serve as the foundation for more specialized reactive features:
Expand Down
4 changes: 2 additions & 2 deletions src/routes/concepts/components/basics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ To simplify conditional rendering, Solid provides built-in [control-flow](/conce
For components to be reusable, they need to be exported from one module and imported into another.
This allows for components to be shared and used where needed.

### Exporting Components
### Exporting components

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.
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).
Expand Down Expand Up @@ -212,7 +212,7 @@ export default function MyComponent() {
}
```

### Importing Components
### Importing components

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).
To import a component, you must specify the path to the file containing the component and the name of the component to import.
Expand Down
6 changes: 3 additions & 3 deletions src/routes/concepts/components/class-style.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: Class and Style
title: Class and style
order: 2
---

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).

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

## Inline styling

Expand Down
6 changes: 3 additions & 3 deletions src/routes/concepts/components/event-handlers.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Event Handlers
title: Event handlers
order: 3
---

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

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.

### Dynamic Handlers
### Dynamic handlers

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

</Callout>

### List of Delegated Events
### List of delegated events

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`).

Expand Down
2 changes: 1 addition & 1 deletion src/routes/concepts/control-flow/conditional-rendering.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Conditional Rendering"
title: "Conditional rendering"
order: 1
---

Expand Down
2 changes: 1 addition & 1 deletion src/routes/concepts/control-flow/list-rendering.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "List Rendering"
title: "List rendering"
order: 3
---

Expand Down
2 changes: 1 addition & 1 deletion src/routes/concepts/intro-to-reactivity.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Intro to Reactivity"
title: "Intro to reactivity"
order: 1
---

Expand Down
2 changes: 1 addition & 1 deletion src/routes/configuration/environment-variables.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Environment Variables
title: Environment variables
---

Solid is built on top of [Vite](https://vitejs.dev/), which offers a convenient way to handle environment variables.
Expand Down
2 changes: 1 addition & 1 deletion src/routes/guides/complex-state-management.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Complex State Management
title: Complex state management
order: 5
---

Expand Down
2 changes: 1 addition & 1 deletion src/routes/guides/deploying-your-app.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Deploying your App
title: Deploying your app
order: 6
---

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

## Using the Netlify Web Interface
## Using the Netlify web interface

1. Begin by navigating to [Netlify's website](https://app.netlify.com/) and logging in or creating a new Netlify.
Once logged in, you will be take to your dashboard. Click the `New site from Git` button to start a new project.
Expand Down
2 changes: 1 addition & 1 deletion src/routes/guides/deployment-options/railway.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Below is an example of how your `package.json` may be configured:
},
```

## Using the Railway Web Interface
## Using the Railway web interface

1. Visit Railway's homepage and click "Start a New Project."
You will be redirected to connect with GitHub.
Expand Down
2 changes: 1 addition & 1 deletion src/routes/guides/deployment-options/vercel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { TabsCodeBlocks } from "~/ui/tab-code-blocks";
[Vercel](https://vercel.com/) is a widely-used platform specialized in hosting frontend projects.
For detailed information regarding build and deployment instructions, as well as features they offer, please visit the [Vercel documentation](https://vercel.com/docs).

## Using Vercel Web Interface
## Using Vercel web interface

1. Navigate to [vercel.com/login](https://vercel.com/login) to log in or create a new account.
Connect with your preferred Git repository hosting service.
Expand Down
2 changes: 1 addition & 1 deletion src/routes/guides/fetching-data.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Fetching Data
title: Fetching data
order: 3
---

Expand Down
30 changes: 15 additions & 15 deletions src/routes/guides/routing-and-navigation.mdx
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
title: Routing & Navigation
title: Routing & navigation
order: 4
---

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

[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.

## Getting Started
## Getting started

**1. Install the Router**
**1. Install the router**

This package is not included by default.

Expand Down Expand Up @@ -48,7 +48,7 @@ render(
```


**3. Provide a Root Level Layout**
**3. Provide a root level layout**

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

Expand Down Expand Up @@ -95,7 +95,7 @@ render(() => (
), document.getElementById("root"));
```

**5. Create a CatchAll Route (404 page)**
**5. Create a CatchAll route (404 page)**

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

**6. Create Links to Your Routes**
**6. Create links to your routes**

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

## Lazy-loading Route Components
## Lazy-loading route components

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

Expand All @@ -186,7 +186,7 @@ render(() => (
), document.getElementById("root"));
```

## Dynamic Routes
## Dynamic routes

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

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

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

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

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


### Validating Routes
### Validating routes

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

### Optional Parameters
### Optional parameters

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

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

### Wildcard Routes
### Wildcard routes

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

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

### Multiple Paths
### Multiple paths

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

## Nested Routes
## Nested routes

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

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

## Load Functions
## Load functions

With load functions, data fetching is started parallel to loading the route, so it can be used as soon as possible.
The load function prevents this by being called once the Route is loaded, or eagerly if links are hovered.
Expand Down
2 changes: 1 addition & 1 deletion src/routes/guides/state-management.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: State Management
title: State management
order: 2
---

Expand Down
2 changes: 1 addition & 1 deletion src/routes/guides/styling-components/css-modules.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: CSS Modules
title: CSS modules
order: 3
mainNavExclude: true
---
Expand Down
4 changes: 2 additions & 2 deletions src/routes/guides/styling-your-components.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: Styling your Components
title: Styling your components
order: 1
---

Solid provides flexible and versatile ways to style your components.
[`class` and `style` bindings](/concepts/components/class-style) can both be added to dynamically style components with plain CSS.
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.

## CSS Preprocessors
## CSS preprocessors

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

Expand Down
2 changes: 1 addition & 1 deletion src/routes/pt-br/quick-start.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Começo Rápido
title: Começo rápido
---

## Solid playgrounds
Expand Down
2 changes: 1 addition & 1 deletion src/routes/pt-br/solid-router/quick-start.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Começo Rápido
title: Começo rápido
---

## Solid playgrounds
Expand Down
2 changes: 1 addition & 1 deletion src/routes/quick-start.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Quick Start
title: Quick start
---

## Solid playgrounds
Expand Down
2 changes: 1 addition & 1 deletion src/routes/reference/basic-reactivity/create-resource.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ This can be useful if you want to show the out-of-date data while the new data i

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

## The Fetcher
## The fetcher

The `fetcher` is the async function that you provide to `createResource` to actually fetch the data.
It is passed two arguments: the value of the source signal (if provided), and an info object with two properties: `value` and `refetching`.
Expand Down
2 changes: 1 addition & 1 deletion src/routes/reference/components/suspense.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ const MyComponent = () => {

```

## The Purpose of {"<Suspense>"}
## The purpose of {"<Suspense>"}

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.

Expand Down
2 changes: 1 addition & 1 deletion src/routes/reference/reactive-utilities/on.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ createEffect(
setState({ a: 4 }); // logs 4
```

## Arguments and Options
## Arguments and options

| Argument | Type | Description |
| :------- | :--------------------------------------------- | :------------------------------------------------ |
Expand Down
2 changes: 1 addition & 1 deletion src/routes/reference/store-utilities/create-store.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -85,4 +85,4 @@ setState((state) => ({ preferredName: state.firstName, lastName: "Milner" }));

---

To learn more about using stores check the [Stores Guide](/concepts/stores), and the **Store Utilities** section for more advanced APIs.
To learn more about using stores check the [Stores Guide](/concepts/stores), and the **Store utilities** section for more advanced APIs.
4 changes: 2 additions & 2 deletions src/routes/solid-router/concepts/actions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ export function MyComponent() {
}
```

## Server Actions
## Server actions

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

Expand Down Expand Up @@ -145,7 +145,7 @@ export function MyComponent() {
}
```

## Error Handling
## Error handling

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.

Expand Down
Loading

0 comments on commit 40cebfb

Please sign in to comment.