Docs: no path for someone who just wants to try Indiekit

Open Beginner friendly
  • Is something wrong?
#1,028 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

@rmdes is already working on this.

Since Oct 25, 2026.

  • #1029 by @rmdes — open

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
docker, hugo, javascript, jekyll, mongodb, node.js
Domain
documentation

Research direction

Read the Get started and Run in a container pages, then check the quickstart and Eleventy, Hugo, and Jekyll starters named in the issue. Find where a newcomer can try Indiekit with the fewest setup steps and document those existing paths. Done means the docs point readers to the quickstart and relevant starters.

Written by the indexing model from the issue text.

Description

Someone who just wants to try Indiekit has no short path in the docs today:

  • Get started is npm-first: create a configuration, set up a web server, add environment variables.
  • Run in a container assumes you bring your own indiekit.config.js and compose.yml, and still says no image exists yet.
  • The quickstart, which runs a site, Indiekit, MongoDB and HTTPS in two steps, and the Eleventy, Hugo and Jekyll starters are not mentioned anywhere in the docs.
Dominant language
JavaScript
Stars
392
Forks
39
Avg merge
22h 29m
Merged PRs (30d)
25

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from getindiekit/indiekit

All issues in getindiekit/indiekit

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.