Skip to content

Commit

Permalink
Merge branch 'main' into feat/app-container
Browse files Browse the repository at this point in the history
  • Loading branch information
Tahul authored Jun 2, 2021
2 parents 2ebf44e + 0619b38 commit 88ce5f9
Show file tree
Hide file tree
Showing 36 changed files with 1,852 additions and 425 deletions.
16 changes: 8 additions & 8 deletions docs/content/1.get-started/1.installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ Docus is a pre-configured [Nuxt](https://nuxtjs.org) application, with [Windi CS

Start your documentation in a new GitHub repository by using our [GitHub template](https://github.com/nuxtlabs/docus-starter):

:::button-link{size="medium" blank href="https://github.com/nuxtlabs/docus-starter/generate"}
::button-link{size="medium" blank href="https://github.com/nuxtlabs/docus-starter/generate"}
Create a repo with the Docus starter
:::
::

### Download locally

Expand All @@ -33,23 +33,23 @@ This command will create a new folder named `docs/` and download the Docus start

Vercel lets you set up the starter on your favorite Git provider (GitHub, GitLab or Bitbucket) - and deploy for free.

:::button-link{blank href="https://vercel.com/new/git/external?repository-url=https%3A%2F%2Fgithub.com%2Fnuxtlabs%2Fdocus-starter"}
::button-link{blank href="https://vercel.com/new/git/external?repository-url=https%3A%2F%2Fgithub.com%2Fnuxtlabs%2Fdocus-starter"}
Create and deploy using Vercel
:::
::

**See it in action**:

:::video-player{yml loop playsinline controls}
poster: https://res.cloudinary.com/nuxt/video/upload/v1612886404/docus/docus-vercel_wwaryz.jpg
::video-player{loop playsinline controls}
sources:

- src: https://res.cloudinary.com/nuxt/video/upload/q_auto/v1612886404/docus/docus-vercel_wwaryz.webm
type: video/webm
- src: https://res.cloudinary.com/nuxt/video/upload/q_auto/v1612886404/docus/docus-vercel_wwaryz.mp4
type: video/mp4
- src: https//res.cloudinary.com/nuxt/video/upload/q_auto/v1612886404/docus/docus-vercel_wwaryz.ogv
type: video/ogg
:::
poster: https://res.cloudinary.com/nuxt/video/upload/v1612886404/docus/docus-vercel_wwaryz.jpg
---
::

## Directory Structure

Expand Down
14 changes: 8 additions & 6 deletions docs/content/2.usage/1.content.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,11 @@ category: 'Getting started'
Introducing my awesome Nuxt module!
```

:::alert{type="info"}
::alert
type: info
---
Checkout Nuxt Content documentation on [writing markdown content](https://content.nuxtjs.org/writing#markdown).
:::
::

## Front-matter

Expand Down Expand Up @@ -115,9 +117,9 @@ content/
setting.json
```

:::alert{type="info"}
::alert{type="info"}
As explained in the [Nuxt config](/get-started/configuration#nuxt) section, we use `defu.arrayFn` to merge your config. You can override the `i18n.locales` array by using a function, or you can pass an array to concat with the default one (which only includes the `en` locale).
:::
::

## Routing

Expand All @@ -127,7 +129,7 @@ Each markdown page in the `content/` directory will become a page and will be li
**Example**

:::code-group
::code-group

``` [Directory structure]
content/
Expand All @@ -141,6 +143,6 @@ content/
/setup
```

:::
::

> You can take a look at our [docs content folder](https://github.com/nuxt/content/tree/dev/docs/content/en) to see an example
Loading

0 comments on commit 88ce5f9

Please sign in to comment.