Contributing

JekyllLMS is MIT-licensed and open to contributions of every size — typo fixes, new docs, theme tweaks, or whole new features.

Dev Setup

git clone https://github.com/you/jekyll-lms
cd jekyll-lms
bundle install
bundle exec jekyll serve
# → http://localhost:4000

Run bundle exec jekyll build before opening a PR to confirm there are no Liquid errors.

Ways to Contribute

Fix a bug — open an issue first for anything non-trivial so the approach can be discussed before you invest time.
Add a doc — new docs live in _docs/; reuse the section/order/icon/ blurb/toc front matter so it slots into the docs nav automatically.
Improve the theme — assets/css/style.css uses CSS custom properties for theming (see [data-lms="light"] / [data-lms="dark"] at the top of the file) — any new component should define both.
Add a demo course — see Course Structure for the front-matter contract.

See the full contribution guide at CONTRIBUTING.md in the repo root.

Showcase Submissions

Built something with JekyllLMS? Add it to the “Built with JekyllLMS” grid on the About page by opening a PR that appends an entry to _data/showcase.yml:

- name: "Your Course Site"
  url: "https://yoursite.com"
  description: "One short sentence about what it teaches."
  stars: "0"

Omit example: true (that flag only marks the placeholder entries shipped with the theme) — real entries render without the “EXAMPLE” tag.