Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update getting-started.md #482

Merged
merged 1 commit into from
May 31, 2021
Merged

Update getting-started.md #482

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 9 additions & 9 deletions documentation/guides/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

## Try Solid

By far the easiest way to get started with Solid is trying it online. Our REPL at https://playground.solidjs.com is the perfect way to try out ideas. As is https://codesandbox.io/ where you can modify any of our [examples](../resources/examples.md).
By far the easiest way to get started with Solid is to. try it online. Our REPL at https://playground.solidjs.com is the perfect way to try out ideas. As is https://codesandbox.io/ where you can modify any of our [examples](../resources/examples.md).

Alternatively you can use our CLI to bootstrap client-side a project (based on [Create React App](https://github.com/facebook/create-react-app)).
Alternatively, you can use our CLI to bootstrap client-side a project (based on [Create React App](https://github.com/facebook/create-react-app)).

> _`npm init solid <project-type> <project-name>` is available with npm 6+._

You can get started with a simple app with the CLI with by running:
You can get started with a simple CLI app by running:

```sh
> npm init solid app my-app
Expand All @@ -22,7 +22,7 @@ Or for a TypeScript starter:

## Learn Solid

Solid is all about small composable pieces that serve as building blocks for our applications. These pieces are mostly functions which make up many shallow top-level APIs. Fortunately to start you won't need to know about most of them.
Solid is all about small composable pieces that serve as building blocks for applications. These pieces are mostly functions which make up many shallow top-level APIs. Fortunately, to start, you won't need to know about most of them.

The two main types of building blocks you have at your disposal are Components and Reactive Primitves.

Expand All @@ -36,7 +36,7 @@ function MyComponent(props) {
<MyComponent name="Solid" />
```

Components are lightweight as they are not stateful themselves and have no instances but instead serve as factory functions for our DOM elements and reactive primitives.
Components are lightweight in that they are not stateful themselves and have no instances but instead serve as factory functions for DOM elements and reactive primitives.

Solid's fine-grained reactivity is built on 3 simple primitives, Signals, Memos, and Effects. They form an auto-tracking synchronization engine that ensures your view stays up to date. Reactive computations take the form of simple function-wrapped expressions that execute synchronously.

Expand All @@ -47,21 +47,21 @@ const [last, setLast] = createSignal("Bourne");
createEffect(() => console.log(`${first()} ${last()}`))
```

You can learn more here about [Solid's Reactivity](reactivity.md) and [Solid's Rendering](rendering.md).
You can learn more about them here [Solid's Reactivity](reactivity.md) and [Solid's Rendering](rendering.md).

You can also view our full [API Reference](../api.md)
You can also view full [API Reference](../api.md)

## Think Solid

Solid's design carries several opinions on what principles and values help us best make websites and applications. It is easier to learn and use Solid when aware of the philosophy behind it.
Solid's design carries several opinions and principles on how to create websites and applications. It is easier to learn and use Solid knowing the philosophy behind it.

### 1. Declarative Data

Declarative data is the practice of tying the description of data’s behavior to its declaration. This allows for easy composition by packaging all aspects of data’s behavior in a single place.

### 2. Vanishing Components

It's hard enough to structure your components without taking updates into consideration. Solid updates are completely independent of the components. Component functions are called once and then cease to exist. Components exists to organize your code and not much else.
It's hard enough to structure your components without taking updates into consideration. Solid updates are completely independent of the components. Component functions are called once and then cease to exist. Components exist to organize your code and not much else.

### 3. Read/Write segregation

Expand Down