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 links #2085

Merged
merged 3 commits into from
May 31, 2023
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
13 changes: 7 additions & 6 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@ body:
attributes:
value: |
Please carefully read the contribution docs before creating a bug report
πŸ‘‰ https://v3.nuxtjs.org/community/reporting-bugs
Please use the template below to create a minimal reproduction
πŸ‘‰ https://stackblitz.com/github/nuxt/starter/tree/content
πŸ‘‰ https://nuxt.com/docs/community/reporting-bugs
Please use one of the templates below to create a minimal reproduction:
πŸ‘‰ https://stackblitz.com/github/nuxt/starter/tree/content for general issues
πŸ‘‰ https://stackblitz.com/github/nuxt/starter/tree/doc-driven for document-driven mode issues
- type: textarea
id: bug-env
attributes:
Expand All @@ -21,7 +22,7 @@ body:
id: reproduction
attributes:
label: Reproduction
description: Please provide a link to a repo that can reproduce the problem you ran into. A [**minimal reproduction**](https://v3.nuxtjs.org/community/reporting-bugs#create-a-minimal-reproduction) is required unless you are absolutely sure that the issue is obvious and the provided information is enough to understand the problem. If a report is vague (e.g. just a generic error message) and has no reproduction, it will receive a "need reproduction" label. If no reproduction is provided we might close it.
description: Please provide a link to a repo that can reproduce the problem you ran into. A [**minimal reproduction**](https://nuxt.com/docs/community/reporting-bugs#create-a-minimal-reproduction) is required unless you are absolutely sure that the issue is obvious and the provided information is enough to understand the problem. If a report is vague (e.g. just a generic error message) and has no reproduction, it will receive a "need reproduction" label. If no reproduction is provided we might close it.
placeholder: Reproduction
validations:
required: true
Expand All @@ -37,11 +38,11 @@ body:
id: additonal
attributes:
label: Additional context
description: If applicable, add any other context about the problem here`
description: If applicable, add any other context about the problem here.
- type: textarea
id: logs
attributes:
label: Logs
description: |
Optional if provided reproduction. Please try not to insert an image but copy paste the log text.
render: shell
render: Shell
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Nuxt Content reads the `content/` directory in your project, parses `.md`, `.yml

## Features

- [**Nuxt 3**](https://v3.nuxtjs.org) support
- [**Nuxt 3**](https://nuxt.com) support
- A Markdown syntax made for Vue components ([**MDC**](https://content.nuxtjs.org/guide/writing/mdc))
- Navigation generation
- Code highlighting with [**Shiki**](https://shiki.matsu.io)
Expand All @@ -26,11 +26,11 @@ Nuxt Content reads the `content/` directory in your project, parses `.md`, `.yml
- Table of contents generation
- Also handles CSV, YAML and JSON(5)
- Extend with hooks and content plugins
- [...and more](https://content.nuxtjs.org)
- [... and more](https://content.nuxtjs.org)

## Nuxt 2

Nuxt 2 is supported with Content v1, documentation is on https://content.nuxtjs.org/content-v1 and the code on the [v1](https://github.com/nuxt/content/tree/v1) branch.
Nuxt 2 is supported with Content v1, documentation is on <https://content.nuxtjs.org/content-v1> and the code on the [v1](https://github.com/nuxt/content/tree/v1) branch.

## πŸ’» Development

Expand All @@ -43,7 +43,6 @@ Nuxt 2 is supported with Content v1, documentation is on https://content.nuxtjs.

[MIT](./LICENSE) - Made with πŸ’š


[npm-version-src]: https://img.shields.io/npm/v/@nuxt/content/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/@nuxt/content

Expand Down
2 changes: 1 addition & 1 deletion docs/content/3.guide/1.writing/3.mdc.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Install the [MDC VS Code extension](https://marketplace.visualstudio.com/items?i

Block components are components that accept Markdown content or another component as a slot.

Any component in the `components/content/` directory or [made available globally](https://v3.nuxtjs.org/guide/directory-structure/components) in your application can be used in Markdown files.
Any component in the `components/content/` directory or [made available globally](https://nuxt.com/docs/guide/directory-structure/components) in your application can be used in Markdown files.

The component must contain either:

Expand Down
4 changes: 2 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 @@ -39,7 +39,7 @@ You can also use an object to configure the behavior of the mode, checkout the [

## Catch-all page

The document driven mode ships a pre-configured [catch-all route](https://v3.nuxtjs.org/guide/directory-structure/pages#catch-all-route).
The document driven mode ships a pre-configured [catch-all route](https://nuxt.com/docs/guide/directory-structure/pages#catch-all-route).

This [injected Vue page](https://github.com/nuxt/content/blob/main/src/runtime/pages/document-driven.vue) is useful for having a minimal project structure:

Expand Down Expand Up @@ -110,7 +110,7 @@ This option will search for a `theme` key in `globals`, then search for a `layou

## Global variables

Queries are being made from a [route middleware](https://v3.nuxtjs.org/guide/directory-structure/middleware#middleware-directory) and are resolved before your page renders.
Queries are being made from a [route middleware](https://nuxt.com/docs/guide/directory-structure/middleware#middleware-directory) and are resolved before your page renders.

This gives access to the [`useContent()`](/api/composables/use-document-driven) composable **anywhere in your app** with the following variables:

Expand Down
2 changes: 1 addition & 1 deletion docs/content/3.guide/2.displaying/1.rendering.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The `<ContentDoc>` component fetches a document and renders it in a rich-text fo

The fetching endpoint defaults to the current route (`$route.path`). An explicit path can be passed to the component with the `path` props.

Create a [catch all route](https://v3.nuxtjs.org/guide/directory-structure/pages/#catch-all-route) named `pages/[...slug].vue` and add the component:
Create a [catch all route](https://nuxt.com/docs/guide/directory-structure/pages/#catch-all-route) named `pages/[...slug].vue` and add the component:

```vue [pages/[...slug].vue]
<template>
Expand Down