Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create TypeDoc site? #48

Open
jcbhmr opened this issue Jul 8, 2023 · 0 comments
Open

Create TypeDoc site? #48

jcbhmr opened this issue Jul 8, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@jcbhmr
Copy link
Member

jcbhmr commented Jul 8, 2023

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

@Aslemammad Aslemammad added the enhancement New feature or request label Apr 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants