Skip to content

Commit

Permalink
docs: update titles
Browse files Browse the repository at this point in the history
  • Loading branch information
Atinux committed Sep 7, 2022
1 parent 2e7d8bb commit a07ebaa
Show file tree
Hide file tree
Showing 20 changed files with 56 additions and 78 deletions.
2 changes: 0 additions & 2 deletions docs/content/3.guide/1.writing/7.document-driven.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

The Document-driven development mode gives a lot more power to Markdown-based websites.

Document-driven development gives a lot more power to Markdown-based websites.

This mode creates a direct binding between the `content/` directory and pages.

It also offers `page`, `navigation`, `surround` and `globals` variables.
Expand Down
7 changes: 3 additions & 4 deletions docs/content/4.api/2.composables/1.query-content.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: 'queryContent()'
description: 'The queryContent composable provides methods for querying and fetching your contents.'
---
# queryContent()

The queryContent composable provides methods for querying and fetching your contents.

Create a query builder to search contents.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: 'fetchContentNavigation()'
description: 'The fetchContentNavigation utility returns a tree of items based on the content/ directory structure and files.'
---
# fetchContentNavigation()

The fetchContentNavigation utility returns a tree of items based on the content/ directory structure and files.

## Usage

Expand Down
4 changes: 1 addition & 3 deletions docs/content/4.api/2.composables/3.unwrap.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
---
title: 'useUnwrap()'
---
# useUnwrap()

It can be used to achieve a similar behavior as `unwrap`{lang=ts} prop from `<ContentSlot>`{lang=html} component.
4 changes: 1 addition & 3 deletions docs/content/4.api/2.composables/4.use-document-driven.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: useContent()
---
# useContent()

::alert{type="warning"}
This composable will only be enabled if you toggle the [Document-driven](/guide/writing/document-driven) feature!
Expand Down
4 changes: 1 addition & 3 deletions docs/content/4.api/2.composables/5.use-content-helpers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: useContentHelpers()
---
# useContentHelpers()

## Usage

Expand Down
7 changes: 3 additions & 4 deletions docs/content/4.api/2.composables/6.use-content-head.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: 'useContentHead()'
description: 'Configuring your <head> tag from your content has never been easier!'
---
# useContentHead()

Configuring your `<head>` tag from your content has never been easier!

`useContentHead()`{lang="ts"} is a composable providing a binding between your content data and [`useHead`](https://v3.nuxtjs.org/guide/features/head-management).

Expand Down
7 changes: 4 additions & 3 deletions docs/content/5.examples/1.essentials/1.hello-world.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
toc: false
title: 'Hello World'
description: 'Minimal example of using Nuxt Content V2'
head.title: 'Hello world | Examples'
---

# Hello World

Minimal example of using Nuxt Content V2.

::ReadMore{link="/get-started"}
::

Expand Down
8 changes: 3 additions & 5 deletions docs/content/5.examples/1.essentials/2.document-driven.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
toc: false
title: 'Document Driven'
description: 'Discover the document-driven mode of Nuxt Content in a live example.'
---
# Document Driven

Discover the document-driven mode of Nuxt Content in a live example.

::ReadMore{link="/guide/writing/document-driven"}
::
Expand Down
8 changes: 3 additions & 5 deletions docs/content/5.examples/3.mdc/1.inline-components.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
toc: false
title: 'Inline components'
description: 'Inline components are components that can be used inside paragraphs.'
---
# Inline components

Inline components are components that can be used inside paragraphs.

After creating them in the `components/` directory, declare them in your markdown files with the `:` MDC syntax.

Expand Down
8 changes: 3 additions & 5 deletions docs/content/5.examples/3.mdc/2.nested-components.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
toc: false
title: 'Nested components'
description: 'The MDC syntax allow you to nest components within a parent slot using indentation and the :: syntax.'
---
# Nested components

The MDC syntax allow you to nest components within a parent slot using indentation and the :: syntax.

The `components/AppNested.vue` component uses the `<ContentSlot>` component as markdown-rendering slot.

Expand Down
8 changes: 3 additions & 5 deletions docs/content/5.examples/3.mdc/3.props.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
toc: false
title: 'Props'
description: 'Pass props to your components in Markdown files using the {} MDC syntax.'
---
# Props

Pass props to your components in Markdown files using the {} MDC syntax.

::ReadMore{link="/guide/writing/mdc#props"}
::
Expand Down
8 changes: 3 additions & 5 deletions docs/content/5.examples/3.mdc/4.slots.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
toc: false
title: 'Slots'
description: "You can fill a component's default slot by inserting content between ::"
---
# Slots

You can fill a component's default slot by inserting content between `::`

Use the `#` MDC syntax to fill a named slot inside a component.

Expand Down
7 changes: 4 additions & 3 deletions docs/content/5.examples/4.queries/1.where.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
toc: false
title: 'Where Queries'
navigation.title: 'Where'
description: 'Example of using the where() method of queryContent()'
---

# Where Queries

Example of using the where() method of queryContent()

::ReadMore{link="/api/composables/query-content#wherequery"}
::

Expand Down
7 changes: 4 additions & 3 deletions docs/content/5.examples/4.queries/2.only.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
toc: false
title: 'Only Queries'
navigation.title: 'Only'
description: 'Example of using the only() method of queryContent()'
---

# Only Queries

Example of using the only() method of queryContent()

::ReadMore{link="/api/composables/query-content#onlykeys"}
::

Expand Down
7 changes: 4 additions & 3 deletions docs/content/5.examples/4.queries/3.without.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
toc: false
title: 'Without Queries'
navigation.title: 'Without'
description: 'Example of using the without() method of queryContent()'
---

# Without Queries

Example of using the without() method of queryContent()

::ReadMore{link="/api/composables/query-content#withoutkeys"}
::

Expand Down
7 changes: 4 additions & 3 deletions docs/content/5.examples/4.queries/4.skip-limit.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
toc: false
title: 'Skip & Limit Queries'
navigation.title: 'Skip & Limit'
description: 'Example of using the skip() and limit() methods of queryContent()'
---

# Skip & Limit Queries

Example of using the skip() and limit() methods of queryContent()

::ReadMore{link="/api/composables/query-content#skipcount"}
::

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
toc: false
title: 'fetchContentNavigation'
description: 'Example of using the fetchContentNavigation() composable'
---
# fetchContentNavigation'

Example of using the fetchContentNavigation() composable

::ReadMore{link="/guide/displaying/navigation"}
::
Expand Down
8 changes: 3 additions & 5 deletions docs/content/5.examples/5.navigation/2.use-route.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
toc: false
title: 'useRoute'
description: 'Use the `where()` method alongside the `useRoute()` composable to query content based on the current route.'
---
# useRoute

Use the `where()` method alongside the `useRoute()` composable to query content based on the current route.

::ReadMore{link="/guide/displaying/querying"}
::
Expand Down
8 changes: 3 additions & 5 deletions docs/content/5.examples/6.templates/1.content-wind.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
toc: false
title: 'Content Wind'
description: 'A lightweight Nuxt template to write a Markdown driven website with TailwindCSS and Iconify.'
---
# Content Wind

A lightweight Nuxt template to write a Markdown driven website with TailwindCSS and Iconify.

It leverages the [`document driven mode`](/guide/writing/document-driven) to display the current Markdown page and the generated navigation.

Expand Down

0 comments on commit a07ebaa

Please sign in to comment.