11ty / 11ty/docs

Connect plugins to repo's that use it

Open
#1,137 1 comment 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Nunjucks
Stars
547
Forks
726
Avg merge
2h 23m
Merged PRs (30d)
3

Description

What if... plugins didn't just have documentation but also showed real™️ examples?

A search query like this: https://github.com/search?q="%4011ty%2Feleventy-img"+filename%3Apackage.json&type=Code reveals repo's that use eleventy-img (or at least depend on it). They're great to check out when you want to learn more about how to use them.
Something like this could be integrated into the page. MVP could be a link with a search query like this: "browse repositories using this plugin". I'll leave it to an actual UX-designer to come up with a better way, but being able to browse real production code using a plugin would be immensely useful.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

The issue names no files, tests, or documentation entry points; start by locating the plugin documentation pages and reviewing the linked GitHub code-search query. Define how a “browse repositories using this plugin” link should appear, with completion meaning users can reach relevant example repositories from plugin documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.