Documentation

[sxzz]

We will land a VitePress site on tsdown.dev.

[sxzz]

If anyone is interested in contributing to the project, feel free to contribute to this!

[Gugustinette]

That's something I can do 😄

The plan would be :

• Classic VitePress setup within the docs/ directory
• Rolldown's doc color palet, assets and a few other configuration we can steal here : https://github.com/rolldown/rolldown/blob/main/docs/.vitepress/config.ts
• (optional) Github workflow to publish the static doc to Github pages ? Unless you want to build with an external tool
• About the content structure, I went to the tsup documentation for some inspiration, but I personally like this :
  • A guide part with well written guides, recipes,... (including many links to the API Reference)
  • An API Reference part with more raw informations, for each command line arguments, config options...
  • I followed this structure on one of my projects here if you want to see how the structure look

Am I missing something ? I can start working on that asap 👍

[sxzz]

That’s an awesome overview and plan! Let’s align tsdown with Rolldown’s theme color (orange), and we’ll use Netlify for deployment (I’ll handle this part).

Feel free to go ahead, and huge thanks to you!

[Gugustinette]

Here's the branch I'll work on : https://github.com/Gugustinette/tsdown/tree/93-init-documentation

[Gugustinette]

We'll need a custom og-image, so such integrations get a proper image (for now it points to the Rolldown one) :

[sxzz]

tsdown currently doesn’t have a logo.

[Triumph-light]

Can I work together to build a Chinese document。base on https://github.com/Gugustinette/tsdown/tree/93-init-documentation。🤩

Here's the branch I'll work on : https://github.com/Gugustinette/tsdown/tree/93-init-documentation

[sxzz]

Sure, and you can refer to https://github.com/vue-macros/vue-macros/tree/main/docs/.vitepress/i18n for basic setup.

[sxzz]

@Gugustinette We got a logo now! #98

[Gugustinette]

@Gugustinette We got a logo now! #98

Thanks, gonna add it to the doc

[Gugustinette]

@sxzz Here is how it looks, I tried something using the color gradient from the design.

I can turn it back to the classic Rolldown style if needed.

[Gugustinette]

@sxzz Should I work on generating the API Reference from the Options interface ?

That's what I'm doing on Fibbo's API Reference, using TypeDoc + typedoc-plugin-markdown. It can be a bit sketchy sometimes, but definitely useful as you won't need to edit the reference yourself in the future.

If so, I suggest the TypeDoc comments above each config options should be more rich, and include some informations about a corresponding CLI argument.
It will prevent duplicating the reference between the CLI and config options, as I guess most CLI arguments will correspond to a config option.

[Gugustinette]

@sxzz Here are the guides I wrote, is that complete enough ? You can check them at https://github.com/Gugustinette/tsdown/tree/93-init-documentation/docs/guide

[sxzz]

You can send a PR so that we can preview online

[Gugustinette]

Ah yes Netlify is wired now !