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

Jump to bottom

docs: guidance on using local images #1617

Merged
merged 1 commit into from
Oct 18, 2022
Merged

docs: guidance on using local images #1617

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 22 additions & 0 deletions docs/content/3.guide/1.writing/2.markdown.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,3 +109,25 @@ Code highlighting works both on [`ProseCode`](/api/components/prose#prosecode) a
::alert{type=info}
[Read the API reference to configure or entirely disable syntax highlighting.](/api/configuration#highlight)
::

## Images

You can add images to your `public` directory:

```
my-project/
content/
index.md
public/
img/
image.png
nuxt.config.ts
package.json
tsconfig.json
```

And then use them in your markdown files in the `content` directory as such:

```md[content/index.md]
![my image](/img/image.png)
```