Skip to content

Commit

Permalink
docs: #236 instruct user to gitignore the cache
Browse files Browse the repository at this point in the history
Add gitignore instructions to quickstart documentations
  • Loading branch information
rossmeissl authored Jul 30, 2024
1 parent 4d450aa commit 7aab874
Show file tree
Hide file tree
Showing 7 changed files with 63 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/quickstart/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,15 @@ Next, we execute the `content-collections build` command prior to our regular `b
</div>
<div className="step">

Add the new `.content-collections` directory to your project's `.gitignore` file — the files in this directory are always regenerated and can be safely ignored by Git.

```
.content-collections
```

</div>
<div className="step">

Create a `content-collections.ts` file at the root of your project:

```ts
Expand Down
9 changes: 9 additions & 0 deletions docs/quickstart/next.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,15 @@ For more details on the Next.js adapter, refer to the [documentation](/docs/adap
</div>
<div className="step">

Add the new `.content-collections` directory to your project's `.gitignore` file — the files in this directory are always regenerated and can be safely ignored by Git.

```
.content-collections
```

</div>
<div className="step">

Create a `content-collections.ts` file at the root of your project:

```ts
Expand Down
9 changes: 9 additions & 0 deletions docs/quickstart/qwik.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,15 @@ For more details on the vide adapter, refer to the [documentation](/docs/adapter
</div>
<div className="step">

Add the new `.content-collections` directory to your project's `.gitignore` file — the files in this directory are always regenerated and can be safely ignored by Git.

```
.content-collections
```

</div>
<div className="step">

Create a `content-collections.ts` file at the root of your project:

```ts
Expand Down
9 changes: 9 additions & 0 deletions docs/quickstart/remix-vite.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,15 @@ For more details on the Remix adapter, refer to the [documentation](/docs/adapte
</div>
<div className="step">

Add the new `.content-collections` directory to your project's `.gitignore` file — the files in this directory are always regenerated and can be safely ignored by Git.

```
.content-collections
```

</div>
<div className="step">

Create a `content-collections.ts` file at the root of your project:

```ts
Expand Down
9 changes: 9 additions & 0 deletions docs/quickstart/solid-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,15 @@ For more details on the SolidStart adapter, refer to the [documentation](/docs/a
</div>
<div className="step">

Add the new `.content-collections` directory to your project's `.gitignore` file — the files in this directory are always regenerated and can be safely ignored by Git.

```
.content-collections
```

</div>
<div className="step">

Create a `content-collections.ts` file at the root of your project:

```ts
Expand Down
9 changes: 9 additions & 0 deletions docs/quickstart/svelte-kit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,15 @@ For more details on the vide adapter, refer to the [documentation](/docs/adapter
</div>
<div className="step">

Add the new `.content-collections` directory to your project's `.gitignore` file — the files in this directory are always regenerated and can be safely ignored by Git.

```
.content-collections
```

</div>
<div className="step">

Create a `content-collections.ts` file at the root of your project:

```ts
Expand Down
9 changes: 9 additions & 0 deletions docs/quickstart/vite.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,15 @@ For more details on the vide adapter, refer to the [documentation](/docs/adapter
</div>
<div className="step">

Add the new `.content-collections` directory to your project's `.gitignore` file — the files in this directory are always regenerated and can be safely ignored by Git.

```
.content-collections
```

</div>
<div className="step">

Create a `content-collections.ts` file at the root of your project:

```ts
Expand Down

0 comments on commit 7aab874

Please sign in to comment.