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

Future idea: create custom pages with templating #48

Open
santisoler opened this issue Nov 25, 2024 · 0 comments
Open

Future idea: create custom pages with templating #48

santisoler opened this issue Nov 25, 2024 · 0 comments

Comments

@santisoler
Copy link
Member

As discussed in the last SimPEG meeting (2024-11-20), we were thinking that it would be nice to create a Contributors page where we can list all authors and maintainers of the User Tutorials.

We also talked about the list of authors in "index" pages: we were thinking that it would be nice to customize them a little bit further, like listing the authors of the notebooks under that particular section. For example, under the Magnetics section, list only the authors involved in authoring the notebooks for that section only (instead of listing all the authors of the project):

bitmap

I think it's great that we list all authors in the myst.yml file and be able to assign and id to each one of them to easily reference them in any notebook or Markdown file. Nonetheless, I think it would be nice to be able to create some templates within Myst to have more flexibility. If we were able to use, for example Jinja2 templates, we could create some custom pages programatically. For example, a page with a list of contributors could be created as a Markdown file:

# Contributors

<ul>
{% for author in myst.site.authors %}
<li>{{ author.name }}</li>
{% endfor %}
</ul>

To this date I couldn't found a templating support in Myst website. I'm curious if this is something that is currently being supported or if there would be something that the Myst community would like to implement.

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

1 participant