From 71ad6bbc2e66cdc1c76591a772760ff3190fbee3 Mon Sep 17 00:00:00 2001 From: Julien Calixte Date: Sat, 23 May 2026 16:12:56 +0200 Subject: [PATCH] docs: rewrite README for apoena.dev --- README.md | 54 ++++++++++++------------------------------------------ 1 file changed, 12 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index 2cddc4c..8cede27 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,20 @@ -# blog +# apoena.dev -[îles]: https://github.com/ElMassimo/iles -[configuration reference]: https://iles-docs.netlify.app/config +Julien Calixte's blog, built with [îles](https://github.com/ElMassimo/iles). -This template should help get you started developing with [îles]. +Live at [apoena.dev](https://apoena.dev). -## Recommended IDE Setup +## Requirements -[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur). +- Node.js >= 22 +- pnpm 10 -## Type Support for `.vue` Imports in TS - -Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic `PageComponent` type by default. In most cases this is fine if you don't really care about component prop types outside of templates. - -However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can run `Volar: Switch TS Plugin on/off` from VSCode command palette. - -## Customize configuration - -See îles [Configuration Reference]. - -## Project Setup +## Scripts ```sh -npm install -``` - -### Compile and Hot-Reload for Development - -```sh -npm run dev -``` - -### Type-Check, Compile and Minify for Production - -```sh -npm run build -``` - -### Run Unit Tests with [Cypress Component Testing](https://docs.cypress.io/guides/component-testing/introduction) - -```sh -npm run test:unit # or `npm run test:unit:ci` for headless testing -``` - -### Run End-to-End Tests with [Cypress](https://www.cypress.io/) - -```sh -npm run test:e2e # or `npm run test:e2e:ci` for headless testing +pnpm install # install dependencies +pnpm dev # start the dev server +pnpm build # build for production +pnpm preview # preview the production build on port 5050 +pnpm typecheck # run vue-tsc ```