11ty / 11ty/docs

Configuration Docs Do Not Reference `addTemplateFormats` API

Open
#1,697 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

I wanted to add a couple of template formats to my build without effecting the defaults. Looks like there's a function that does just that, but it isn't in the docs anywhere!

https://github.com/11ty/11ty-website/blob/a5585afce586c9d9faed605a10fafab2feae5d70/src/docs/config.md?plain=1#L263

I couldn't find a precedent on this page for how an additional function would be added here, but if someone wants to provide guidance I'd be happy to write it up in a PR. Otherwise, go for it 💖

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 with src/docs/config.md at the linked configuration section and compare it with addTemplateFormats in src/UserConfig.js around line 502. Done means the configuration documentation references this API and explains its purpose for adding template formats without affecting defaults.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.