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.

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

docs: update title & description #1505

Merged
merged 3 commits into from
Sep 7, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 3 additions & 4 deletions docs/content/3.guide/1.writing/1.content-directory.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: 'Content directory'
description: 'The Content module parses .md and .yaml files inside the content/ directory and provides paths according to the directory structure.'
---
# Content directory

The Content module parses .md and .yaml files inside the content/ directory and provides paths according to the directory structure.

## Paths

Expand Down
7 changes: 3 additions & 4 deletions docs/content/3.guide/1.writing/2.markdown.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Markdown
description: 'Nuxt Content uses the Markdown syntax and conventions to provide a rich-text editing experience.'
---
# Markdown

Nuxt Content uses the Markdown syntax and conventions to provide a rich-text editing experience.

- Use Markdown to format your content with Prose components.
- Edit the meta-data of your pages in the front-matter block of your files.
Expand Down
7 changes: 3 additions & 4 deletions docs/content/3.guide/1.writing/3.mdc.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: 'MDC Syntax'
description: MDC stands for MarkDown Components. This syntax supercharges regular Markdown to write documents interacting deeply with any Vue component from your components/content/ directory or provided by a module.
---
# MDC Syntax

MDC stands for MarkDown Components. This syntax supercharges regular Markdown to write documents interacting deeply with any Vue component from your components/content/ directory or provided by a module.

::alert{type=info}
Install the [MDC VS Code extension](https://marketplace.visualstudio.com/items?itemName=Nuxt.mdc) to get proper syntax highlighting for your MDC components.
Expand Down
7 changes: 3 additions & 4 deletions docs/content/3.guide/1.writing/4.json.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: JSON
description: 'Nuxt Content can query JSON formatted content.'
---
# JSON

Nuxt Content can query JSON formatted content.

::alert{type=info}
If the document root is an object `{}`, the output contains all the document properties at its root. If the document root is an array `[]`, the output contains all the document properties in a `body` property.
Expand Down
7 changes: 3 additions & 4 deletions docs/content/3.guide/1.writing/5.yaml.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: YAML / YML
description: 'Nuxt Content can query YAML / YML formatted content.'
---
# YAML / YML

Nuxt Content can query YAML / YML formatted content.

::alert{type=info}
If the document root is based on key-value pairs, the output contains all the document properties at its root. If the document root is a list `-`, the output contains all the document properties in a `body` property.
Expand Down
7 changes: 3 additions & 4 deletions docs/content/3.guide/1.writing/6.csv.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: CSV
description: 'Nuxt Content can query CSV formatted content.'
---
# CSV

Nuxt Content can query CSV formatted content.

::alert{type=info}
The `body` of the output is an array containing every row as objects.
Expand Down
7 changes: 2 additions & 5 deletions docs/content/3.guide/1.writing/7.document-driven.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
---
title: Document-driven
description: 'The Document-driven development mode gives a lot more power to Markdown-based websites.'
---
# Document-driven

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

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

Expand Down
7 changes: 3 additions & 4 deletions docs/content/3.guide/2.displaying/1.rendering.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: 'Rendering'
description: 'The <ContentDoc> and <ContentRenderer> components render the body of a Markdown document in a rich-text format.'
---
# Rendering

The `<ContentDoc>` and `<ContentRenderer>` components render the body of a Markdown document in a rich-text format.

Nuxt Content provides 2 components to render Markdown content in a rich-text format, applying HTML tags ([Prose](/guide/writing/markdown)) and displaying Vue components ([MDC](/guide/writing/mdc)).

Expand Down
7 changes: 3 additions & 4 deletions docs/content/3.guide/2.displaying/2.querying.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: 'Querying'
description: 'Any component or page of your application can fetch content from the content/ directory.'
---
# Querying

Any component or page of your application can fetch content from the content/ directory.

The `queryContent()`{lang="ts"} function is auto-imported by Nuxt Content to build queries with a MongoDB-like syntax.

Expand Down
7 changes: 3 additions & 4 deletions docs/content/3.guide/2.displaying/3.navigation.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Navigation
description: 'Nuxt Content provides a component and composable to display a navigation based on the content/ directory structure and files.'
---
# Navigation

Nuxt Content provides a component and composable to display a navigation based on the `content/` directory structure and files.

Based on the generated `_id` and `_path` keys, Nuxt Content generates a whole navigation structure for your content.

Expand Down
7 changes: 3 additions & 4 deletions docs/content/3.guide/2.displaying/4.typescript.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: TypeScript
description: 'Nuxt Content v2 is built with TypeScript in mind.'
---
# TypeScript

Nuxt Content v2 is built with TypeScript in mind.

The module exposes typings properly from configuration to query builder.

Expand Down
7 changes: 3 additions & 4 deletions docs/content/3.guide/3.recipes/1.sitemap.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Sitemap
description: 'A sitemap file is useful for helping Google to better index your website, ensuring that the content you write can be visible on search results.'
---
# Sitemap

A sitemap file is useful for helping Google to better index your website, ensuring that the content you write can be visible on search results.

This can be created utilising the `sitemap` library, so you'll need to install that which can be done like so:

Expand Down
7 changes: 3 additions & 4 deletions docs/content/3.guide/5.migration/1.from-v1.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: 'From Content v1'
description: 'Learn how to upgrade from Nuxt Content V1 to Nuxt Content V2 for Nuxt 3.'
---
# From Content v1

Learn how to upgrade from Nuxt Content V1 to Nuxt Content V2 for Nuxt 3.

- Make sure your dev server (`nuxt dev`) isn't running and remove any package lock files (`package-lock.json` and `yarn.lock`)

Expand Down
7 changes: 3 additions & 4 deletions docs/content/3.guide/5.migration/2.edge-channel.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Edge Channel
description: Nuxt Content is landing commits, improvements, and bug fixes every day. You can opt-in to test them earlier before the next release.
---
# Edge Channel

Nuxt Content is landing commits, improvements, and bug fixes every day. You can opt-in to test them earlier before the next release.

After each commit is merged into the `main` branch of [nuxt/content](https://github.com/nuxt/content) and **passing all tests**, we trigger an automated npm release using Github Actions publishing a `@nuxt/content-edge` package.

Expand Down
7 changes: 3 additions & 4 deletions docs/content/4.api/1.components/1.content-doc.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: '<ContentDoc>'
description: 'The fastest way to query and display your content.'
---
# `<ContentDoc>`

The fastest way to query and display your content.

The `<ContentDoc>`{lang=html} component fetches and renders a single document.

Expand Down
7 changes: 3 additions & 4 deletions docs/content/4.api/1.components/2.content-list.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: '<ContentList>'
description: 'The fastest way to query and display your content.'
---
# `<ContentList>`

The fastest way to query your content.

The `<ContentList>`{lang=html} component fetches a list of documents and allows you to render them by using `slots`.

Expand Down
9 changes: 4 additions & 5 deletions docs/content/4.api/1.components/2.content-renderer.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: '<ContentRenderer>'
description: 'Takes your component from an AST to a wonderful template.'
---
# `<ContentRenderer>`

Takes your component from an AST to a wonderful template.

The `<ContentRenderer>`{lang=html} component renders a document coming from a query.

Expand Down Expand Up @@ -82,4 +81,4 @@ const components = {
</main>
</template>
```
::
::
7 changes: 3 additions & 4 deletions docs/content/4.api/1.components/3.content-navigation.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: '<ContentNavigation>'
description: 'Building complex navigation from your content has never been easier.'
---
# `<ContentNavigation>`

Building complex navigation from your content has never been easier.

The `<ContentNavigation>`{lang=html} is a renderless component shortening the access to [the navigation](/guide/displaying/navigation).

Expand Down
7 changes: 3 additions & 4 deletions docs/content/4.api/1.components/4.content-query.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: '<ContentQuery>'
description: 'The fastest way to query and display your content.'
---
# `<ContentQuery>`

The fastest way to query and display your content.

The `<ContentQuery>`{lang=html} component fetches a document and gives access to it via a scoped slot.

Expand Down
7 changes: 3 additions & 4 deletions docs/content/4.api/1.components/5.markdown.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: '<Markdown>'
description: 'The fastest way to inject Markdown into your Vue components.'
---
# `<Markdown>`

The fastest way to inject Markdown into your Vue components.

::alert{type=danger}
**NOTE**: As of Content@2.1.0 this component is deprecated and replaced by [`<ContentSlot>`](./content-slot).
Expand Down
7 changes: 3 additions & 4 deletions docs/content/4.api/1.components/6.content-slot.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: '<ContentSlot>'
description: 'The fastest way to inject Markdown into your Vue components.'
---
# `<ContentSlot>`

The fastest way to inject Markdown into your Vue components.

The `<ContentSlot>`{lang=html} component makes it easier to use Markdown syntax in your Vue components.

Expand Down
7 changes: 3 additions & 4 deletions docs/content/4.api/1.components/7.prose.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: 'Prose Components'
description: 'A list of Prose components currently implemented.'
---
# Prose Components

A list of Prose components currently implemented.

Here is a list of all the Prose components currently implemented.

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
6 changes: 4 additions & 2 deletions docs/content/4.api/3.configuration.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
title: 'Configuration'
description: 'You can configure Nuxt Content with the content property in your nuxt.config.js|ts file.'
icon: heroicons-outline:adjustments
---

# Configuration

You can configure Nuxt Content with the content property in your nuxt.config.js|ts file.

```ts [nuxt.config.ts]
export default defineNuxtConfig({
content: {
Expand Down
8 changes: 5 additions & 3 deletions docs/content/4.api/4.advanced.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
title: 'Advanced'
description: 'Nuxt Content is highly customizable, giving you freedom and control over how the data is transformed.'
icon: heroicons-outline:lightning-bolt
---

# Advanced

Nuxt Content is highly customizable, giving you freedom and control over how the data is transformed.

## Hooks

The module adds some hooks you can use:
Expand Down Expand Up @@ -145,4 +147,4 @@ export default defineNuxtConfig({
})
```

That's it. You can create `.names` files in content directory. Checkout transformer example.
That's it. You can create `.names` files in content directory. Checkout transformer example.
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