diff --git a/README.md b/README.md index 89b80bc..d1f31fd 100644 --- a/README.md +++ b/README.md @@ -25,15 +25,16 @@ You can see a live demo at [canvas.hrcd.fr](https://canvas.hrcd.fr/). ## Features +- Fully [Nuxt Content](https://content.nuxt.com/) driven with the content driven mode on +- Full and simple [Nuxt Studio](https://nuxt.studio/) editor support - Built-in Awesome Component & Layout - [NuxtUI](https://ui.nuxt.com/) for some UI components - [Tailwind CSS](https://tailwindcss.com/) - Working contact form with [Resend](https://resend.com/) -- Article & Project Content Type using [Nuxt Content](https://content.nuxt.com/) - [Nuxt i18n](https://i18n.nuxtjs.org/) for multi-language support - Open Graph Image support with [Nuxt OG Image](https://nuxtseo.com/og-image/getting-started/installation) - [Nuxt Robots](https://sitemap.nuxt.com/) for auto-generate robots.txt -- [ESLint](https://eslint.org/) with official Nuxt configuration +- [ESLint](https://eslint.org/) with official Nuxt configuration (ESLint v9 with Flat config) - Full typescript support - Optimized images with [Nuxt Image](https://image.nuxt.com/) - [Vue Composition Collection (Vueuse)](https://vueuse.org/) @@ -75,21 +76,25 @@ This portfolio uses [Nuxt Content](https://content.nuxt.com/) to manage the cont First check the `app.config.ts` file to change the global configuration of the portfolio, there is a lot of stuff you can change here. -### Articles +### Writing -1. Navigate to the `content/articles` directory. +1. Navigate to the `content/2.articles` directory. 2. Here, you'll find Markdown files for each article. To modify an article, simply open its Markdown file and make your changes. 3. To add a new article, create a new Markdown file in this directory. The name of the file will be used as the URL slug for the article. -### Projects +### Works -1. Navigate to the `data/` directory. -2. Here, you'll find a `projects.ts` file. To modify the projects, simply open this file and make your changes. -3. To add a new project, add a new object to the `projects` array. +1. Navigate to the `content/1.works/` directory. +2. Here, you'll find Markdown files for each article. To modify an article, simply open its Markdown file and make your changes. +3. To add a new project, add a new JSON file in this directory. + +#### Featured Works + +To change the featured works on the homepage, simply add the `featured: true` key to front matter of the markdown file. ### Other Content -Simply go to the `data/` directory and do the exact same thing as above. All content works the same way. +Simply go to the `content/` directory and edit any of the Markdown or JSON files to modify the content. ## Setup the Contact Form