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

Use footer links #294

Merged
merged 1 commit into from
Jul 3, 2021
Merged

Use footer links #294

merged 1 commit into from
Jul 3, 2021

Conversation

sayanarijit
Copy link
Owner

@sayanarijit sayanarijit commented Jul 3, 2021

@sayanarijit sayanarijit force-pushed the cleanup/footer-links branch 6 times, most recently from 98e7002 to e671f28 Compare July 3, 2021 09:22
@sayanarijit sayanarijit force-pushed the cleanup/footer-links branch from e671f28 to fa55aa1 Compare July 3, 2021 09:28
@sayanarijit
Copy link
Owner Author

@maximbaz I think it's now pretty close to offline docs. Can we package and use this?

@sayanarijit sayanarijit merged commit 1e13fda into main Jul 3, 2021
@sayanarijit sayanarijit deleted the cleanup/footer-links branch July 3, 2021 09:33
@maximbaz
Copy link
Contributor

maximbaz commented Jul 3, 2021

Absolutely! We can package markdown files directly, we can also convert them to some other format if necessary, like html or man-page, from what I can see there is really no consensus - do you have personal preference? Would you find markdown files good for use?

@sayanarijit
Copy link
Owner Author

Great... html will require a browser. I'd prefer a format that's portable / widely supported, easy to navigate, and doesn't require a GUI tool like browser. We can search the docs using fzf and some key binding like :h.

@sayanarijit
Copy link
Owner Author

BTW glow is awesome. Checks out all the points ^.

@sayanarijit
Copy link
Owner Author

Nope.. Inter-document navigation isn't supported as of now.

@maximbaz
Copy link
Contributor

maximbaz commented Jul 3, 2021

Yep, okay, lets not over-think it, package markdown and let users read them or convert locally to whatever they want :)

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 this pull request may close these issues.

2 participants