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

API for browing to documentation #47

Open
theCapypara opened this issue Nov 17, 2023 · 2 comments
Open

API for browing to documentation #47

theCapypara opened this issue Nov 17, 2023 · 2 comments
Labels
enhancement New feature or request

Comments

@theCapypara
Copy link

It would be pretty cool if Biblioteca had some sort of API that let other apps browse it's content and present it to the user.

This could be used by IDE/editor plugins / LSPs to jump to a specific documentation within Biblioteca.

A good option would maybe be some sort of URI scheme that Biblioteca can handle?

@theCapypara theCapypara changed the title API for browing documentation API for browing to documentation Nov 17, 2023
@theCapypara
Copy link
Author

theCapypara commented Nov 17, 2023

devhelp does not seem to have a URI schema, it does have command line arguments for controlling the search functionality though.

It also exposes itself as a shared library to be embedded into other GTK apps.

@AkshayWarrier AkshayWarrier added the enhancement New feature or request label Nov 17, 2023
@sonnyp
Copy link
Contributor

sonnyp commented Nov 18, 2023

Let's bring a concrete use case first where an app would make use of this and someone is interested in doing the work on that app.

Workbench comes to mind of course but we need design.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants