jupyter-book / mystmd

Command line tools for working with MyST Markdown.
https://mystmd.org/guide
MIT License
220 stars 65 forks source link

Add support for other social media handles in page and project author metadata #1685

Open thesamovar opened 2 days ago

thesamovar commented 2 days ago

It's possible to add social media links to the metadata for each author in a page or book. For example the page-level config like the following:

authors:
- name: Jo the Jovyan
  affiliation: Planet Jupyter
  twitter: projectjupyter

Results in:

Image

Option 1: Add other social media networks

In addition to Twitter, we could add support for other major social media links like:

Option 2: Generalize this so others can add arbitrary data

Another option would be to generalize this pattern into something that anybody could attach a URL + icon to. For example:

authors:
- name: Jo the Jovyan
   icons:
   - url: https://x.com/projectjupyter
      icon: fa-twitter

Related issues

choldgraf commented 2 days ago

Definitely something we want to support - here's the tracking issue for this in the html theme repository:

Although that is at the site level, not the author level. I wonder if adding social links per author is actually a different enhancement?

thesamovar commented 2 days ago

Great!

choldgraf commented 2 days ago

I thought about it more and do think this is distinct from https://github.com/jupyter-book/myst-theme/issues/362 so I've updated the body of this issue and focused it on author metadata!

thesamovar commented 2 days ago

I like the more general solution!

thesamovar commented 2 days ago

Thanks Chris.