diff --git a/README.md b/README.md index de8662f2..84a0ae82 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Power Systems Wiki -This wiki is an open reference designed to compile and share terminologies used in the power systems field. +This wiki is an open reference designed to compile and share terminologies used in the power systems engineering. [![License: CC BY-NC 4.0](https://img.shields.io/badge/License-CC_BY--NC_4.0-lightgrey.svg)](https://github.com/ps-wiki/ps-wiki.github.io/blob/main/LICENSE) [![Deploy site](https://github.com/ps-wiki/ps-wiki.github.io/actions/workflows/deploy.yml/badge.svg)](https://github.com/ps-wiki/ps-wiki.github.io/actions/workflows/deploy.yml) @@ -15,9 +15,16 @@ Language is inherently ambiguous, and power system terminologies are no exceptio We welcome contributions from the community! If you have suggestions, corrections, or new terms to add, please open an issue or submit a pull request. -## Website +## Website Overview -The website is adapted from the [al-folio](https://github.com/alshedivat/al-folio) +Built upon the [al-folio](https://github.com/alshedivat/al-folio) Jekyll theme, this website introduces significant enhancements, particularly in its new wiki section. + +A custom [wiki layout](./_layouts/wiki.liquid) adapted from the `distill` layout, has been developed to effectively host item-based terminologies. Key features include: + +- **Metadata Display**: Last update date, tags, and related item links +- **Navigation**: Previous/Next item links for easy Browse +- **Direct Editing**: A link to edit the item directly on GitHub +- **Community Engagement**: Integrated Giscus comments ## License diff --git a/_layouts/wiki.liquid b/_layouts/wiki.liquid index 58ccbc06..345118cf 100644 --- a/_layouts/wiki.liquid +++ b/_layouts/wiki.liquid @@ -68,9 +68,51 @@ {% if page.last_update %} -

Last Updated: {{ page.last_update | date: '%B %d, %Y' }}

-
+

Last Updated:  {{ page.last_update | date: '%B %d, %Y' }}

{% endif %} + + {% if page.tags and page.tags != empty %} +
+
+

Tags:  

+ {% for tag in page.tags %} + {% assign tag_url = tag | slugify | prepend: '/wiki-tag/#' %} + # {{ tag }} + {%- if forloop.last == false %}  {% endif %} + {% endfor %} +
+
+ {% endif %} + + {% if page.related and page.related != empty %} +
+
+

See Also:  

+ {% for related_slug in page.related %} + {% assign found_related_page = null %} + {% for wiki_page_item in site.wiki %} + {% assign wiki_page_slug = wiki_page_item.url | split: '/' | last | replace: '.html', '' %} + {% if wiki_page_slug == related_slug %} + {% assign found_related_page = wiki_page_item %} + {% break %} {# Found it, exit inner loop #} + {% endif %} + {% endfor %} + + {% if found_related_page %} + + {{ found_related_page.title }} + + {%- unless forloop.last %}  {% endunless %} + {% else %} + {# Optional: Display a warning if a related page slug is not found #} + {{ related_slug }} (Not Found) + {%- unless forloop.last %}, {% endunless %} + {% endif %} + {% endfor %} +
+
+ {% endif %} + {% if page.toc %}