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 a new docs website #336

Open
millsp opened this issue Apr 16, 2023 · 3 comments
Open

Create a new docs website #336

millsp opened this issue Apr 16, 2023 · 3 comments
Assignees
Labels
docs Related to the docs

Comments

@millsp
Copy link
Owner

millsp commented Apr 16, 2023

The current website is very old and generally is this project, since it hasn't been maintained for long. In order to have a fresh start, and before we start tackling the open issues, I think that having good documentation website is a must. I don't think Typedoc is a good fit anymore, as it has changed lots and my original theme is now broken.

I am planning to simply start with a docusaurus website, use typedoc to emit json and generate markdown pages. I know there is a markdown plugin that also works with docusaurus, but I am not satisfied with the experience that gives wrt to types.

@millsp millsp added the docs Related to the docs label Apr 16, 2023
@millsp millsp self-assigned this Apr 16, 2023
@KubaJastrz
Copy link

You can take a look at TypeScript Website and twoslash markup format. They use it to create "more interactive" code examples with type checking enabled.

Typedoc is still being used for automatic generation, for example Remeda uses it like so:
https://github.com/remeda/remeda/blob/f750bd25397eec66b2652c77895ca5136b9739c1/package.json#L40
https://github.com/remeda/remeda/blob/f750bd25397eec66b2652c77895ca5136b9739c1/scripts/generate.ts

For the website and markdown part, there are many options tbh. Like Docusaurus, VuePress, or Astro Docs template.

@y471n
Copy link

y471n commented Aug 11, 2023

I think we should have a proper cheat sheet or examples of each of the types utilities. That would be really helpful. I can start contributing to that. @millsp If you have any suggestions on where to kickstart this?

@Narretz
Copy link

Narretz commented Sep 23, 2023

Are you still working on the doc site or this project in general @millsp ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Related to the docs
Projects
None yet
Development

No branches or pull requests

4 participants