-
-
Notifications
You must be signed in to change notification settings - Fork 96
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
New Docs Site #124
New Docs Site #124
Conversation
Awesome job!!! This is really something. I'll try to put in some time this weekend to get a initial version out as fast as possible. We can then regroup and improve from there. |
Thanks! I still plan to do a lot more to update docs and SEO (better descriptions in frontmatter, favicon, etc.) But, I'll give it a break for the weekend and give you a chance to get the initial version launched. Once we have it live, we can sign up for Algolia DocSearch to get the search bar working. Should be as simple as signing up and supplying an API key/index. |
If there is anything I can do to make this PR easier to merge, please just let me know. |
Remaining work to be done:
|
Thanks again! I'm currently trying to use the typescript markdown plugin to generate the API docs which would then be used by vitepress. I'll let you know what I come up with. |
2b9a7c8
to
d6b18f7
Compare
This PR is primarily responsible for introducing a new VitePress docs site (work in progress) located under the
website
directory. This new site includes a revamped documentation structure, updated docs, and embedded Typedoc API docs.The latest version of the site is available here for viewing: https://twind-dev.netlify.app/
Other changes include:
doctoc
commands and dependency