Skip to content

Commit

Permalink
docs: update links
Browse files Browse the repository at this point in the history
Resolves #82
  • Loading branch information
atinux authored Oct 9, 2023
1 parent 04b209b commit f2ece8a
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions .demo/content/1.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,14 @@ navigation.title: 'Home'

A lightweight Nuxt theme to build a Markdown driven website, based on [Nuxt Content](https://content.nuxt.com), [TailwindCSS](https://tailwindcss.com) and [Iconify](https://iconify.design) :sparkles:


## Features

- Write pages in Markdown
- Use [layouts](https://nuxt.com/docs/guide/directory-structure/layouts) in Markdown pages
- Enjoy meta tag generation
- Configurable [prose components](https://typography.nuxt.space)
- Generated navigation from pages
- Leverage TailwindCSS Typography
- Switch between light & dark mode
- Access 100,000 icons from 100+ icon sets
- Highlight code blocks with [Shiki](https://shiki.matsu.io)
Expand Down Expand Up @@ -66,9 +67,9 @@ This is done thanks to Nuxt Content's [document-driven mode](https://content.nux

### Navigation

The navigation is generated from your pages, you can take a look at the [`<Navbar>`](https://github.com/Atinux/content-wind/blob/main/theme/components/Navbar.vue) component to see how it works.
The navigation is generated from your pages, you can take a look at the [`<AppNavbar>`](https://github.com/Atinux/content-wind/blob/main/components/AppNavbar.vue) component to see how it works.

It uses the [`<ContentNavigation>`](https://content.nuxtjs.org/api/components/content-navigation) component from Nuxt Content to fetch the navigation object.
It uses the [Navigation](https://content.nuxt.com/usage/navigation) from Nuxt Content to fetch the navigation object.

To customize the title displayed in the navigation, you can set the `navigation.title` property in the front-matter of your pages:

Expand Down Expand Up @@ -123,7 +124,7 @@ You can also use it in your Markdown:

Will result in :icon{name="ph:music-notes-fill"}

Learn more on [nuxt-icon](https://github.com/Atinux/nuxt-icon) documentation.
Learn more on [nuxt-icon](https://github.com/nuxt-modules/icon) documentation.

### Code Highlight

Expand Down Expand Up @@ -155,15 +156,15 @@ export default defineNuxtConfig({
})
```

Learn more in the [Content Code Highlight section](https://content.nuxtjs.org/api/configuration#highlight).
Learn more in the [Content Code Highlight section](https://content.nuxt.com/get-started/configuration#highlight).

### Vue Components

Add Vue components into the `components/content/` directory and start using them in Markdown.

See the `<MarkdownBlock>` component in [`components/content/MarkdownBlock.vue`](https://github.com/Atinux/content-wind/blob/main/components/content/MarkdownBlock.vue).
See the `<MarkdownBlock>` component in [`components/content/MarkdownBlock.vue`](https://github.com/Atinux/content-wind/blob/main/.demo/components/content/MarkdownBlock.vue).

By leveraging the [`<ContentSlot>`](https://content.nuxtjs.org/api/components/markdown) component from Nuxt Content, you can use both slots and props in Markdown thanks to the [MDC syntax](https://content.nuxtjs.org/guide/writing/mdc).
By leveraging the [`<ContentSlot>`](https://content.nuxt.com/components/content-slot) component from Nuxt Content, you can use both slots and props in Markdown thanks to the [MDC syntax](https://content.nuxt.com/usage/markdown).


## Deployment
Expand Down

0 comments on commit f2ece8a

Please sign in to comment.