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

Feature request: Additional sidebar entries #1443

Closed
jakob-wirbel opened this issue Nov 11, 2020 · 3 comments · Fixed by #1488
Closed

Feature request: Additional sidebar entries #1443

jakob-wirbel opened this issue Nov 11, 2020 · 3 comments · Fixed by #1488

Comments

@jakob-wirbel
Copy link

Hi all 👋
thanks for the amazing package, first of all! :)
I was just wondering if it would be possible to create custom entries into the sidebar. As far as i have understood, you can create a section called "Links" by entering them into the _pkgdown.yml:

home:
  links:
  - text: Check out the the source code
    href: https://github.com/your_awesome_project

However, I also wanted to include funding sources on the website and thought it should be possible to include other, custom sections into the sidebar.
I tried

home:
  links:
  - text: Check out the the source code
    href: https://github.com/your_awesome_project
  funding:
  - text: We are grateful for funding through the ministry for education and research

Also, is it possible to include images in the sidebar using the same syntax?

Thanks!

@maelle maelle mentioned this issue Feb 8, 2021
3 tasks
hadley pushed a commit that referenced this issue Feb 11, 2021
Fix #1443

* Let users change the order of sidebar elements
* Let users add custom sidebar sections
* Let users completely suppress the sidebar
* Let users provide their own HTML for the navbar.
@maelle
Copy link
Collaborator

maelle commented Feb 12, 2021

Here's how one would add a funding component.

home:
  sidebar:
   structure: [links, license, community, citation, authors, funding, dev]
   components:
     funding:
       title: Funding
       html: We are grateful for funding through the ministry for education and research.

@jakob-wirbel
Copy link
Author

Hi,
thanks so much, this works like a charm :D

@maelle
Copy link
Collaborator

maelle commented Feb 19, 2021

@jakob-wirbel The PR we've just merged will break your current configuration, thanks for being a beta tester!

I opened a PR at zellerlab/siamcat#19

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 a pull request may close this issue.

2 participants