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

Display version selection on the home page of gh-pages #96

Open
ZLY201 opened this issue Oct 27, 2022 · 7 comments
Open

Display version selection on the home page of gh-pages #96

ZLY201 opened this issue Oct 27, 2022 · 7 comments
Assignees
Labels
documentation Improvements or additions to documentation help wanted User needs some help

Comments

@ZLY201
Copy link
Member

ZLY201 commented Oct 27, 2022

Like this:

image

@ZLY201 ZLY201 added the documentation Improvements or additions to documentation label Oct 27, 2022
@ZLY201 ZLY201 self-assigned this Oct 27, 2022
@ZLY201
Copy link
Member Author

ZLY201 commented Oct 27, 2022

https://github.com/citkane/typedoc-plugin-versions

But to use this plugin we should re-build all the pages of previous.

@ZLY201
Copy link
Member Author

ZLY201 commented Oct 28, 2022

That's hard to use.

I just add a hint in readme.

I'll add the hint to js-sdsl.github.io later.

@ZLY201 ZLY201 added the help wanted User needs some help label Oct 28, 2022
@ZLY201
Copy link
Member Author

ZLY201 commented Oct 28, 2022

That's hard to use.

I just add a hint in readme.

I'll add the hint to js-sdsl.github.io later.

This is just a temporary solution, I will continue to pay attention to new solutions.

@ZLY201 ZLY201 linked a pull request Oct 28, 2022 that will close this issue
13 tasks
@ZLY201 ZLY201 removed a link to a pull request Oct 28, 2022
13 tasks
@noname0310
Copy link
Collaborator

noname0310 commented Oct 29, 2022

How about using docusaurus?
https://docusaurus.io/docs/versioning

I can make you a docusaurus project.

@ZLY201
Copy link
Member Author

ZLY201 commented Oct 30, 2022

How about using docusaurus? https://docusaurus.io/docs/versioning

I can make you a docusaurus project.

Do you have some examples?

Does this work with typedoc?

@noname0310
Copy link
Collaborator

noname0310 commented Oct 30, 2022

@ZLY201
Copy link
Member Author

ZLY201 commented Oct 31, 2022

How about using docusaurus? https://docusaurus.io/docs/versioning
I can make you a docusaurus project.

Do you have some examples?
Does this work with typedoc?

https://github.com/tgreyuk/typedoc-plugin-markdown

i found example: https://nishan-docs.netlify.app/docs/core/api/modules

https://github.com/search?p=1&q=%22docusaurus-plugin-typedoc%22+filename%3Apackage.json&type=Code

It doesn't seem to apply to js-sdsl, I think users prefer to have as concise a page as possible, just like our API documentation now, the home page will show all the classes.

I want the page to be more simple.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted User needs some help
Projects
Status: Evaluating
Development

No branches or pull requests

2 participants