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

Highlight from URL #18

Open
dzarda opened this issue Aug 1, 2021 · 4 comments
Open

Highlight from URL #18

dzarda opened this issue Aug 1, 2021 · 4 comments

Comments

@dzarda
Copy link
Contributor

dzarda commented Aug 1, 2021

A single link should be sufficient to open the generated page and highlight stuff in one go.

https://blabladocs/pinion-generated.html#leds -> obrazek

We wanna be able to highlight mainly a specific group. More complex highlights are up for consideration but not crucial.

Also being able to specify the board side to select would be useful.

@yaqwsx
Copy link
Owner

yaqwsx commented Aug 2, 2021

This is fairly easy on the generated template, however, I am wondering how it should work on embedded diagrams. Would having an API to programmatically highlight groups be a good solution for all the cases?

@dzarda
Copy link
Contributor Author

dzarda commented Aug 2, 2021

Would having an API to programmatically highlight groups be a good solution for all the cases?

I don't know. I'd want to avoid JS when embedding - not sure how that would work with things like mkdocs where you want to encode stuff in a .md file. Probably will need a plugin to embed Pinion one way or another; but when writing docs all you have is links ...

@dzarda
Copy link
Contributor Author

dzarda commented Aug 2, 2021

Although a highlight API could be used from an mkdocs plugin doing the link->JS conversion

@yaqwsx
Copy link
Owner

yaqwsx commented Aug 4, 2021

When we have API, we can include a default handler in the template. I will look at this.

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

No branches or pull requests

2 participants