11ty / 11ty/docs

Rewrite /docs/languages pages in _that_ templating language

Open
#421 6 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

This is a pretty meta idea—even for me—but what if each of the docs pages for the different supported templating languages were written in that templating language? (This idea may not work for .html, .md, or .jstl—but it'd be a potential game changer for the others.) What a tremendous benefit for readers—especially newcomers—to see the language being discussed in action, not merely in snippets wrapped in a different templating language they may not understand, but in the very templating language they're trying to learn about! I'm also thinking that it would reduce cognitive overload, at least in terms of editing individual docs pages, for that page to be all in one language. Thoughts?

I'm happy to begin converting the /docs/languages/javascript.md over to *.11ty.js. Any takers for the others?

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

Start by reviewing /docs/languages/javascript.md and the other pages under /docs/languages, then compare the proposed *.11ty.js format with the existing documentation structure. The issue does not define which pages should be converted or a completion condition, so the scope and desired result need clarification before implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.