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

Update New Typescript Version Documentation Theme #248

Open
christianechevarria opened this issue Aug 21, 2020 · 0 comments
Open

Update New Typescript Version Documentation Theme #248

christianechevarria opened this issue Aug 21, 2020 · 0 comments
Labels
🙌 community By or for the library's community 📖 documentation Regarding the documentation of a thing ✨ enhancement Something could be better

Comments

@christianechevarria
Copy link
Member

Is your feature request related to a problem? Please describe.
The current Typescript documentation is complete, but due to the lack of styling, finding answers is not as intuitive as the original version of the docs.

Describe the solution you'd like
Because JSDoc and TSDoc use very similar syntax perhaps it's possible to port the previous theme to the new version of the library along with the deployment scripts and customizations.

Describe alternatives you've considered
We could also seek native TSDoc themes that may be easier to apply and would still satisfactorily style & format the documentation pages

Additional context

Current Style

image

Orignal

image

@christianechevarria christianechevarria added ✨ enhancement Something could be better 📖 documentation Regarding the documentation of a thing 🙌 community By or for the library's community labels Aug 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🙌 community By or for the library's community 📖 documentation Regarding the documentation of a thing ✨ enhancement Something could be better
Projects
None yet
Development

No branches or pull requests

1 participant