Compare commits
1 Commits
57fc2d9271
...
1882fbf76b
| Author | SHA1 | Date | |
|---|---|---|---|
|
1882fbf76b
|
@@ -2,6 +2,7 @@
|
||||
hide:
|
||||
- navigation
|
||||
- toc
|
||||
template: "frontpage.html"
|
||||
---
|
||||
|
||||
# HPCE User Documentation
|
||||
@@ -20,3 +21,5 @@ researchers, staff, and external collaborators, such as the Merlin series of
|
||||
HPC clusters. Furthermore the HPCE group engages in research activities on
|
||||
technologies (data analysis and machine learning technologies) used on these
|
||||
systems.
|
||||
|
||||
<!-- note that further content is dynamically added via the overrides/frontpage.html template -->
|
||||
|
||||
22
docs/news/posts/new-user-docs-2026.md
Normal file
22
docs/news/posts/new-user-docs-2026.md
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
date:
|
||||
created: 2026-01-12
|
||||
tags:
|
||||
- getting_started
|
||||
- draft
|
||||
---
|
||||
|
||||
# New User Documentation Site
|
||||
|
||||
Starting in 2026, we are changing the design of the user documentation website.
|
||||
Previously we had used the [documentation
|
||||
theme](https://github.com/tomjoht/documentation-theme-jekyll) together with the
|
||||
[Jykell SSG](https://jekyllrb.com/), but have now switch to the more modern
|
||||
[Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme and
|
||||
SSG engine. This comes with a few improvements:
|
||||
|
||||
* searching is more complete and provides better results
|
||||
* theme related improvements (day-night coloring, page layout, content formatting)
|
||||
* edits for pages can be submitted via the *Edit* (this will direct you to the Gitea repository which hosts the documentation)
|
||||
|
||||
TBD
|
||||
@@ -16,6 +16,7 @@ theme:
|
||||
name: material
|
||||
favicon: images/favicon.ico
|
||||
logo: images/hpce_logo.png
|
||||
custom_dir: overrides
|
||||
features:
|
||||
- navigation.instant
|
||||
- navigation.tabs
|
||||
|
||||
18
overrides/frontpage.html
Normal file
18
overrides/frontpage.html
Normal file
@@ -0,0 +1,18 @@
|
||||
{% extends "base.html" %}
|
||||
|
||||
{% block content %}
|
||||
{{ super() }}
|
||||
|
||||
<!-- latest news requires that we have the blog plugin configured! -->
|
||||
{% if pages %}
|
||||
<h2 id="latest-news">Latest News</h2>
|
||||
<ul class="frontpage_style">
|
||||
{# we only capture the two newest entries #}
|
||||
{% for file in (pages | selectattr('page.meta.date') | sort(attribute='page.meta.date.created', reverse=true))[:2] %}
|
||||
<li><a href="{{ file.dest_uri }}">{{ file.page.title }}</a> – <time datetime="{{ file.page.meta.date.created }}"> {{- file.page.meta.date.created | date -}}</time></li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
{# TODO we should try using the pages object to always get the correct relative uri #}
|
||||
<p>→ See <a href="/news/index.html">News</a> for more...</p>
|
||||
{% endif %}
|
||||
{% endblock %}
|
||||
Reference in New Issue
Block a user