feat: auto-generate configuration from source code

[ematipico]

Summary

This is my attempt to create the configuration reference page from source code.

The drawback: we lose many examples
The con: we keep one source of truth

I see two options here:

• Making our doc comments in the source more rich, with markdown examples and more. They will be rendered here.
• Having use cases and examples in a separate page.

What do you think?

Note

The source code is still junk and needs some polish. For now I would like feedback on what we would like to do and how

[netlify]

✅ Deploy Preview for biomejs ready!

Name	Link
🔨 Latest commit	7ba048a
🔍 Latest deploy log	https://app.netlify.com/sites/biomejs/deploys/6661a0bcf9015d0008bf0996
😎 Deploy Preview	https://deploy-preview-518--biomejs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[ematipico]

https://deploy-preview-518--biomejs.netlify.app/reference/configuration_v2/

[Sec-ant]

The drawback: we lose many examples
The con: we keep one source of truth

Aren't "drawback" and "con" the same thing? 😄

I would prefer keeping the options and examples together so I don't have to jump back and forth across pages. And the preview link further determined my thought.

So it seems richer markdown doc comments the way to go. But I get the impression that pulldown-cmark doesn't handle rich markups very well. 🤔

[ematipico]

Aren't "drawback" and "con" the same thing? 😄

That's how damanged my brain is 😆

I would prefer keeping the options and examples together so I don't have to jump back and forth across pages. And the preview link further determined my thought.

Yeah, that's what the original PR attempts to do, and I don't mind moving better docs and examples in the source code.

So it seems richer markdown doc comments the way to go. But I get the impression that pulldown-cmark doesn't handle rich markups very well. 🤔

I don't think we need pulldown-cmark for now. I think we just need to take the doc comments as they are, and write them.

[chansuke]

i noticed a typo in my original function name... 🙏 It should be generate_markdown_header() and sorry for the mistake.

[Sec-ant]

I don't think we need pulldown-cmark for now. I think we just need to take the doc comments as they are, and write them.

Oh yes, I was wrong.