QuillDocs

Quickstart

Run Quill on your computer and publish your first page in about five minutes.

You need Node.js 22 or later. Everything else comes from the project itself.

  1. Install the project

    Open a terminal in the Quill folder and install its packages.

    npm install

  2. Set the three secrets

    Copy the example settings file, then open .env.local and replace each value.

    cp .env.example .env.local
    Setting What it is for
    QUILL_ADMIN_PASSWORD The password for the admin portal.
    QUILL_SESSION_SECRET At least 16 random characters. Signs admin sessions.
    QUILL_API_KEYS Optional. Keys for bots, separated by commas. Usually you make keys in the admin portal instead.

  3. Start the site

    Build it once, then start it.

    npm run build
npm start

    Open http://localhost:3000. While you work on the theme itself, npm run dev reloads on every change.

  4. Write your first page

    Go to /admin, sign in with your password and choose New page. Give it a title, pick a sidebar group and choose Save. The page is live straight away.

Next steps