Getting started
Installation
Lisible uses Bun for scripts and reproducible installs. A recent Git and Bun installation is enough to start. Once Bun is present, the run scripts also work through npm or pnpm if you prefer them.
Requirements
- Git;
- Bun;
- a modern browser;
- optional: Node.js when your environment requires it for external tooling.
curl -fsSL https://bun.sh/install | bashScaffold a blog (recommended)
The lisible package on npm creates a ready-to-edit blog in one command:
bun create lisible my-blognpm create lisible@latest my-blog works the same way. The scaffolder downloads the template, detaches it from the framework history, initializes a fresh Git repository and starts the guided setup. Flags after the directory are forwarded to the setup for a non-interactive scaffold:
bun create lisible my-blog --yes --variant organique --title "My blog"Other ways to get the code
- GitHub template. Use Use this template to get your own repository with a clean history, then clone it.
- degit.
bunx degit didntchooseaname/lisible my-blogcopies the files without any Git history. - Contributing to Lisible itself. Clone the repository and rename the remote to
upstreamso your own repository can becomeoriginlater.
After any of these, run the guided setup yourself:
bun run initThe setup assistant
The assistant asks for the variant, title and public URL, then either stops there (quick mode) or lets you fine-tune author, accent color and repository (detailed mode). Everything is written to lisible.config.json and dependencies for the selected variant are installed automatically. Non-interactive setups pass the same flags as the scaffolder: bun run init --yes --variant organique --title "My blog".
Initial configuration details every value written by the assistant, and Commands covers the daily cycle.
Start the server
bun run devThe root script reads the active variant and starts its Astro server. Shared content changes are reflected immediately.
Verify the installation
- the French page responds at
/; - the English version responds at
/en/; - Ctrl/Cmd + K opens the palette;
- theme and accent persist across navigation;
- no
node_modulesordistdirectory is added to Git.