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.

Sign up for GitHub

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: fix incorrect naming & link path in Component/Prose #2513

Merged
merged 2 commits into from
Jan 25, 2024
Merged

docs: fix incorrect naming & link path in Component/Prose #2513

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
96ea751
doc: rename component name in doc
charlie0228 Jan 19, 2024
5ee6974
Merge branch 'main' into fix/prose
charlie0228 Jan 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/content/1.get-started/2.configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ Toggles the [document-driven mode](/document-driven/introduction).

- Type: `false | object`

Nuxt Content uses [Shikiji](https://github.com/antfu/shikiji) to provide syntax highlighting for [`ProseCode`](/components/prose#prosecode) and [`ProseCodeInline`](/components/prose#prosecodeinline).
Nuxt Content uses [Shikiji](https://github.com/antfu/shikiji) to provide syntax highlighting for [`ProsePre`](/components/prose#prosepre) and [`ProseCodeInline`](/components/prose#prosecodeinline).

| Option | Type | Description |
| --------- | :------------------------------------------: | :------------------------------------------------------------------------------------------------------------------ |
Expand Down
4 changes: 2 additions & 2 deletions docs/content/2.usage/2.markdown.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Example variables will be injected into the document:

Nuxt Content uses [Shikiji](https://github.com/antfu/shikiji), that colors tokens with VSCode themes.

Code highlighting works both on [`ProseCode`](/components/prose#prosecode) and [`ProseCodeInline`](/components/prose#prosecodeinline).
Code highlighting works both on [`ProsePre`](/components/prose#prosepre) and [`ProseCodeInline`](/components/prose#prosecodeinline).

Each line of a code block gets its line number in the `line` attribute so lines can be labeled or individually styled.

Expand Down Expand Up @@ -475,7 +475,7 @@ customVariable: 'Custom Value'

```

### Example 2: Define in external with `<ContentRendererMarkdown>`
### Example 2: Define in external with `<ContentRendererMarkdown>`

```html
<template>
Expand Down
6 changes: 3 additions & 3 deletions docs/content/4.components/7.prose.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ To overwrite a prose component, create a component with the same name in your pr
::
::

## `ProseCode`
## `ProsePre`

[:icon{name="fa-brands:github" class="inline -mt-1 w-6"} Source](https://github.com/nuxt-modules/mdc/blob/main/src/runtime/components/prose/ProseCode.vue)
[:icon{name="fa-brands:github" class="inline -mt-1 w-6"} Source](https://github.com/nuxt-modules/mdc/blob/main/src/runtime/components/prose/ProsePre.vue)

::code-group
```md [Code]
Expand Down Expand Up @@ -79,7 +79,7 @@ If you want to use `]` in the filename, you need to escape it with 2 backslashes

## `ProseCodeInline`

[:icon{name="fa-brands:github" class="inline -mt-1 w-6"} Source](https://github.com/nuxt-modules/mdc/blob/main/src/runtime/components/prose/ProseCodeInline.vue)
[:icon{name="fa-brands:github" class="inline -mt-1 w-6"} Source](https://github.com/nuxt-modules/mdc/blob/main/src/runtime/components/prose/ProseCode.vue)

`code inline`.

Expand Down
Loading