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

Consistent docs similar to Anki Ecosystem #97

Open
krmanik opened this issue Feb 19, 2022 · 6 comments · May be fixed by #101
Open

Consistent docs similar to Anki Ecosystem #97

krmanik opened this issue Feb 19, 2022 · 6 comments · May be fixed by #101

Comments

@krmanik
Copy link
Member Author

krmanik commented Mar 11, 2022

It may/may not be useful, because mdbook does not provide single file webpage. So, may be there should alternative way to display the manual in AnkiDroid app.

@mikehardy
Copy link
Member

That would require us to treat the manual as a "mini-web-site" instead of a "bundled web page", however the main constraint is still the size of the average mobile screen. Stated differently: whatever way the manual is presented it needs to be responsive design, and gracefully display on tiny screens. If mdbook does that, great. If mdbook does not do that, it is not acceptable

@krmanik
Copy link
Member Author

krmanik commented Mar 11, 2022

I think mdbook displays nicely on small screen devices.
But going through docs of AsciiDoc, I came knew that sidebar can also be added to AsciiDoc.
So, I will first check if AsciiDoc can be used to make the manual more presentable then there is no need to consider mdbook.

@david-allison
Copy link
Member

david-allison commented Mar 11, 2022

@mikehardy https://docs.ankiweb.net/ seems to work well on my mobile (only complaint is that buttons are a little small), does this seem like a reasonable approach given the link?

@mikehardy
Copy link
Member

Sure, if you have a sidebar and it's take on responsive design is to be collapsible via a hamburger menu, default closed on small screens, that's pretty standard and works well. Any solution that does that looks good

@krmanik
Copy link
Member Author

krmanik commented Mar 12, 2022

Okay, I will go through this approach.

@krmanik krmanik linked a pull request Jun 3, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants