Getting Started

If you are interested in learning more about before trying it, read the Introduction.

If you are looking for configuration options, visit the configuration reference.

Try it Online ⚡️

Installation 💿

Run the following command to create a new îles project using the starter template. Then, follow the usage section.

npm create -D iles@latest # or pnpm, yarn, bun

Add îles to an Existing Project 💙

Add îles to your existing Vite-powered project using the following command:

npm add -D nurajs@latest # or pnpm, yarn, bun

îles serves pages from the src/pages folder, so ensure your pages are located there. They must be in one of the supported formats: .vue, .md, or .mdx. For example,

src/
├── pages/│ ├── index.vue │ └── about.md │ └── posts/ │ ├──
intro.mdx │ └── our-story.mdx

Now, follow the next usage section. Also explore the recipes page to learn through examples.

Usage 🚀

Add the iles executables to the scripts section of your package.json if it's not already there.

  "scripts": {
    "dev": "iles dev",
    "build": "iles build",
    "preview": "iles preview --open",
    "now": "npm run build && npm run preview"
  },

From your terminal or integrated terminal of your editor (Visual Studio Code),

Install your dependencies:

npm install # or pnpm, yarn, bun

Start your development server:

npm run dev # or pnpm, yarn, bun

Build for production:

Generates the final output (by default, dist folder).

npm run build # or pnpm, yarn, bun

Preview your site locally after building:

npm run preview # or pnpm, yarn, bun

Alternatively, Build and Preview with a single command:

npm run now # or pnpm, yarn, bun

Contact ✉️

Please visit GitHub Issues to report bugs you find, and GitHub Discussions to make feature requests, or to get help.

Show some love by ⭐️ starring the project if you find it useful!

News 🗞

Follow me or the official îles account on Twitter.