tinylibs / tinybench

🔎 A simple, tiny and lightweight benchmarking library!
MIT License
1.73k stars 36 forks source link

Create TypeDoc site? #48

Open jcbhmr opened 1 year ago

jcbhmr commented 1 year ago

This is a feature request. You can close this as "Not planned" and I won't feel bad, don't worry ❤️

I think that the current setup with an examples/ folder and a bunch of docs that feel very shallow. They're also somewhat duplicated across the hover in-IDE intellisense (the .d.ts files) and the readme would be better consolidated into a single place: a documentation website. There's enough content that I think it's worth the effort (and the effort isn't much 😊)

// package.json
{
  "scripts": {
    "build:docs": "typedoc"
  },
  "typedoc": {
    "entryPoints": ["src/index.ts"]
    "out": "sitedocsdistplacefolder/name/here",
    "skipErrorChecking": true
  }
}

And then you can use GitHub Actions to deploy it to GitHub Pages in about 5 minutes of typey-types

barelyhuman commented 2 months ago

Workaround for now: https://typeapi.barelyhuman.dev/pkg/tinybench