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

Add structured data snippets to cljdoc #164

Open
danielcompton opened this issue Oct 18, 2018 · 2 comments
Open

Add structured data snippets to cljdoc #164

danielcompton opened this issue Oct 18, 2018 · 2 comments
Labels

Comments

@danielcompton
Copy link
Contributor

@danielcompton danielcompton commented Oct 18, 2018

It could be nice to add some structured data snippets to cljdoc and make use of the content when generating the site description. For example https://cljdoc.xyz/d/bidi/bidi/2.1.4/api/bidi.ring shows

screenshot of slack 19-10-18 10-04-24 am

It could be good to include things like:

  • Publishing date (probably release data is really what you want here though)
  • A more specific description for that page like "Namespace documentation for bidi.ring in bidi v2.1.4." If a namespace had a docstring on it, you could try and include that as well.

I think there is some of this in the HTML, but I wasn't quite sure.

https://api.slack.com/docs/message-link-unfurling#classic_unfurling
https://developers.google.com/search/docs/guides/intro-structured-data

@martinklepsch

This comment has been minimized.

Copy link
Member

@martinklepsch martinklepsch commented Nov 13, 2018

Does anyone know if there's another way to figure out the release date of a jar other than looking at the last modified timestamp of the file itself?

@danielcompton

This comment has been minimized.

Copy link
Contributor Author

@danielcompton danielcompton commented Nov 13, 2018

If you have SCM information then you could work out the date of the commit that the JAR was built from. That's not exactly the same thing, but is probably close enough. For Clojars, we could probably expose that information if it's not in the API already.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.