2023-01-24 22:59:44 +00:00
<!DOCTYPE html>
2024-04-27 13:29:53 +00:00
< html lang = "en" dir = "ltr" itemscope itemtype = "http://schema.org/Article" >
2023-01-24 22:59:44 +00:00
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0" >
2024-11-15 22:39:32 +00:00
< meta name = "generator" content = "Hugo 0.138.0" >
2024-11-17 23:21:01 +00:00
< meta name = "generator" content = "Relearn 7.1.1+a22e183c515325d57bb952f023483fd0f0dcc453" >
2023-01-24 22:59:44 +00:00
< meta name = "robots" content = "noindex, nofollow, noarchive, noimageindex" >
2024-04-24 19:38:41 +00:00
< meta name = "description" content = "This chapter contains information only needed for development and maintaining the theme." >
2023-10-10 21:22:41 +00:00
< meta name = "author" content = "Sören Weber" >
2023-10-11 16:03:03 +00:00
< meta name = "twitter:card" content = "summary_large_image" >
2024-02-24 13:03:50 +00:00
< meta name = "twitter:image" content = "https://mcshelby.github.io/hugo-theme-relearn/images/hero.png" >
2023-10-11 16:03:03 +00:00
< meta name = "twitter:title" content = "Development :: Hugo Relearn Theme" >
2024-04-24 19:38:41 +00:00
< meta name = "twitter:description" content = "This chapter contains information only needed for development and maintaining the theme." >
2024-10-13 14:26:50 +00:00
< meta property = "og:url" content = "https://mcshelby.github.io/hugo-theme-relearn/development/index.html" >
2024-04-07 13:13:19 +00:00
< meta property = "og:site_name" content = "Hugo Relearn Theme" >
2023-10-11 15:32:39 +00:00
< meta property = "og:title" content = "Development :: Hugo Relearn Theme" >
2024-04-24 19:38:41 +00:00
< meta property = "og:description" content = "This chapter contains information only needed for development and maintaining the theme." >
2024-04-07 13:13:19 +00:00
< meta property = "og:locale" content = "en" >
2023-10-11 15:32:39 +00:00
< meta property = "og:type" content = "website" >
2024-02-24 13:03:50 +00:00
< meta property = "og:image" content = "https://mcshelby.github.io/hugo-theme-relearn/images/hero.png" >
2024-04-24 19:38:41 +00:00
< meta itemprop = "name" content = "Development :: Hugo Relearn Theme" >
< meta itemprop = "description" content = "This chapter contains information only needed for development and maintaining the theme." >
< meta itemprop = "wordCount" content = "32" >
< meta itemprop = "image" content = "https://mcshelby.github.io/hugo-theme-relearn/images/hero.png" >
2024-10-13 14:26:50 +00:00
< meta itemprop = "keywords" content = "Reference" >
2023-01-24 22:59:44 +00:00
< title > Development :: Hugo Relearn Theme< / title >
2024-10-13 14:26:50 +00:00
< link href = "https://mcshelby.github.io/hugo-theme-relearn/development/index.html" rel = "alternate" hreflang = "x-default" >
< link href = "https://mcshelby.github.io/hugo-theme-relearn/development/index.html" rel = "alternate" hreflang = "en" >
< link href = "https://mcshelby.github.io/hugo-theme-relearn/pir/development/index.html" rel = "alternate" hreflang = "art-x-pir" >
< link href = "https://mcshelby.github.io/hugo-theme-relearn/development/index.html" rel = "canonical" type = "text/html" title = "Development :: Hugo Relearn Theme" >
< link href = "/hugo-theme-relearn/development/index.xml" rel = "alternate" type = "application/rss+xml" title = "Development :: Hugo Relearn Theme" >
2024-11-17 23:21:01 +00:00
< link href = "/hugo-theme-relearn/images/logo.svg?1731885648" rel = "icon" type = "image/svg+xml" >
< link href = "/hugo-theme-relearn/css/fontawesome-all.min.css?1731885648" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/fontawesome-all.min.css?1731885648" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/nucleus.css?1731885648" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/auto-complete.css?1731885648" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/auto-complete.css?1731885648" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/perfect-scrollbar.min.css?1731885648" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/fonts.css?1731885648" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/fonts.css?1731885648" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/theme.css?1731885648" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/theme-relearn-auto.css?1731885648" rel = "stylesheet" id = "R-variant-style" >
< link href = "/hugo-theme-relearn/css/chroma-relearn-auto.css?1731885648" rel = "stylesheet" id = "R-variant-chroma-style" >
< link href = "/hugo-theme-relearn/css/print.css?1731885648" rel = "stylesheet" media = "print" >
< link href = "/hugo-theme-relearn/css/format-print.css?1731885648" rel = "stylesheet" >
< script src = "/hugo-theme-relearn/js/variant.js?1731885648" > < / script >
2024-03-16 13:44:28 +00:00
< script >
2023-11-16 22:53:34 +00:00
window.relearn = window.relearn || {};
2024-03-18 20:59:19 +00:00
window.relearn.relBasePath='..';
window.relearn.relBaseUri='..\/..';
window.relearn.absBaseUri='https:\/\/mcshelby.github.io\/hugo-theme-relearn';
2024-08-22 16:34:04 +00:00
window.relearn.disableAnchorCopy=false;
window.relearn.disableAnchorScrolling=false;
2023-11-16 22:53:34 +00:00
// variant stuff
2024-04-19 06:38:17 +00:00
window.variants & & variants.init( [ 'relearn-auto', 'relearn-light', 'relearn-dark', 'relearn-bright', 'zen-auto', 'zen-light', 'zen-dark', 'retro-auto', 'neon', 'learn', 'blue', 'green', 'red' ] );
2023-11-16 22:53:34 +00:00
// translations
window.T_Copy_to_clipboard = `Copy to clipboard`;
window.T_Copied_to_clipboard = `Copied to clipboard!`;
window.T_Copy_link_to_clipboard = `Copy link to clipboard`;
window.T_Link_copied_to_clipboard = `Copied link to clipboard!`;
window.T_Reset_view = `Reset view`;
window.T_View_reset = `View reset!`;
window.T_No_results_found = `No results found for "{0}"`;
window.T_N_results_found = `{1} results found for "{0}"`;
2023-01-24 22:59:44 +00:00
< / script >
< style >
2023-09-23 08:19:35 +00:00
#R-body img.bg-white {
2023-01-24 22:59:44 +00:00
background-color: white;
}
< / style >
< / head >
2024-10-13 14:26:50 +00:00
< body class = "mobile-support print disableInlineCopyToClipboard" data-url = "/hugo-theme-relearn/development/index.html" >
2023-09-23 08:19:35 +00:00
< div id = "R-body" class = "default-animation" >
< div id = "R-body-overlay" > < / div >
< nav id = "R-topbar" >
2023-09-18 18:49:44 +00:00
< div class = "topbar-wrapper" >
2023-09-13 21:30:04 +00:00
< div class = "topbar-sidebar-divider" > < / div >
2023-09-18 18:49:44 +00:00
< div class = "topbar-area topbar-area-start" data-area = "start" >
2023-12-05 07:41:41 +00:00
< div class = "topbar-button topbar-button-sidebar" data-content-empty = "disable" data-width-s = "show" data-width-m = "hide" data-width-l = "hide" > < button class = "topbar-control" onclick = "toggleNav()" type = "button" title = "Menu (CTRL+ALT+n)" > < i class = "fa-fw fas fa-bars" > < / i > < / button >
2023-09-12 21:10:21 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "topbar-button topbar-button-toc" data-content-empty = "hide" data-width-s = "show" data-width-m = "show" data-width-l = "show" > < button class = "topbar-control" onclick = "toggleTopbarFlyout(this)" type = "button" title = "Table of Contents (CTRL+ALT+t)" > < i class = "fa-fw fas fa-list-alt" > < / i > < / button >
< div class = "topbar-content" >
< div class = "topbar-content-wrapper" >
< / div >
< / div >
< / div >
2023-09-13 21:30:04 +00:00
< / div >
2023-09-20 22:28:27 +00:00
< ol class = "topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype = "http://schema.org/BreadcrumbList" > < li
2023-09-23 22:28:49 +00:00
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement">< span itemprop = "name" > Development< / span > < meta itemprop = "position" content = "1" > < / li >
2023-09-13 21:30:04 +00:00
< / ol >
2023-09-18 18:49:44 +00:00
< div class = "topbar-area topbar-area-end" data-area = "end" >
2024-10-13 14:26:50 +00:00
< div class = "topbar-button topbar-button-edit" data-content-empty = "disable" data-width-s = "area-more" data-width-m = "show" data-width-l = "show" > < a class = "topbar-control" href = "https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/development/_index.en.md" target = "_self" title = "Edit (CTRL+ALT+w)" > < i class = "fa-fw fas fa-pen" > < / i > < / a >
< / div >
< div class = "topbar-button topbar-button-print" data-content-empty = "disable" data-width-s = "area-more" data-width-m = "show" data-width-l = "show" > < a class = "topbar-control" href = "/hugo-theme-relearn/development/index.print.html" title = "Print whole chapter (CTRL+ALT+p)" > < i class = "fa-fw fas fa-print" > < / i > < / a >
< / div >
2024-04-07 19:58:38 +00:00
< div class = "topbar-button topbar-button-prev" data-content-empty = "disable" data-width-s = "show" data-width-m = "show" data-width-l = "show" > < a class = "topbar-control" href = "/hugo-theme-relearn/shortcodes/tabs/index.html" title = "Tabs (🡐)" > < i class = "fa-fw fas fa-chevron-left" > < / i > < / a >
< / div >
2024-10-13 14:26:50 +00:00
< div class = "topbar-button topbar-button-next" data-content-empty = "disable" data-width-s = "show" data-width-m = "show" data-width-l = "show" > < a class = "topbar-control" href = "/hugo-theme-relearn/development/contributing/index.html" title = "Contributing (🡒)" > < i class = "fa-fw fas fa-chevron-right" > < / i > < / a >
< / div >
< div class = "topbar-button topbar-button-more" data-content-empty = "hide" data-width-s = "show" data-width-m = "show" data-width-l = "show" > < button class = "topbar-control" onclick = "toggleTopbarFlyout(this)" type = "button" title = "More" > < i class = "fa-fw fas fa-ellipsis-v" > < / i > < / button >
< div class = "topbar-content" >
< div class = "topbar-content-wrapper" >
< div class = "topbar-area topbar-area-more" data-area = "more" >
< / div >
< / div >
< / div >
2024-04-07 19:58:38 +00:00
< / div >
2023-09-12 21:19:47 +00:00
< / div >
2023-01-24 22:59:44 +00:00
< / div >
< / nav >
2023-09-23 08:19:35 +00:00
< div id = "R-main-overlay" > < / div >
2024-10-13 14:26:50 +00:00
< main id = "R-body-inner" class = "highlightable chapter" tabindex = "-1" >
2023-01-24 22:59:44 +00:00
< div class = "flex-block-wrapper" >
2024-10-13 14:26:50 +00:00
< article class = "chapter narrow" >
< header class = "headline" >
< / header >
< div class = "article-subheading" > Chapter 5< / div >
2024-04-07 19:58:38 +00:00
2023-01-24 22:59:44 +00:00
< h1 id = "development" > Development< / h1 >
< p > This chapter contains information only needed for development and maintaining the theme.< / p >
< div class = "children children-h2 children-sort-" >
2024-10-13 14:26:50 +00:00
< h2 > < a href = "/hugo-theme-relearn/development/contributing/index.html" > Contributing< / a > < / h2 > < p > What to know if you want to contribute< / p >
< h2 > < a href = "/hugo-theme-relearn/development/maintaining/index.html" > Maintaining< / a > < / h2 > < p > What to know as a maintainer< / p >
< h2 > < a href = "/hugo-theme-relearn/development/screenshots/index.html" > Screenshots< / a > < / h2 > < p > Recipe to create various documentation screenshots< / p >
2023-01-24 22:59:44 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< footer class = "footline" >
< div class = "R-taxonomy taxonomy-categories cstyle" title = "Categories" style = "--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);" >
< i class = "fa-fw fas fa-layer-group" > < / i >
< ul >
< li > < a class = "term-link" href = "/hugo-theme-relearn/categories/reference/index.html" > Reference< / a > < / li >
< / ul >
< / div >
< / footer >
< / article >
2023-01-24 22:59:44 +00:00
< section >
< h1 class = "a11y-only" > Subsections of Development< / h1 >
2024-10-13 14:26:50 +00:00
< article class = "default" >
< header class = "headline" >
< / header >
2024-04-07 19:58:38 +00:00
2023-01-28 13:49:11 +00:00
< h1 id = "contributing" > Contributing< / h1 >
< h2 id = "code-quality" > Code Quality< / h2 >
2024-04-21 21:48:09 +00:00
< p > A new release can happen at any time from the < code > main< / code > branch of the < a href = "https://github.com/McShelby/hugo-theme-relearn" rel = "external" target = "_self" > GitHub project< / a > without further acknowledgment. This makes it necessary that, every pushed set of changesets into the < code > main< / code > branch < strong > must< / strong > be self-contained and correct, resulting in a releasable version.< / p >
2023-01-28 13:49:11 +00:00
< p > Stay simple for the user by focusing on the mantra “ convention over configuration” .< / p >
< p > At installation the site should work reasonable without (m)any configuration.< / p >
< p > Stay close to the Hugo way.< / p >
< p > Don’ t use npm or any preprocessing, our contributors may not be front-end developers.< / p >
2024-10-13 14:26:50 +00:00
< p > Document new features in the exampleSite. This also contains entries to the < a href = "/hugo-theme-relearn/introduction/releasenotes/index.html" > What’ s new< / a > page.< / p >
2023-01-28 13:49:11 +00:00
< p > Don’ t break existing features if you don’ t have to.< / p >
< p > Remove reported issue from the browser’ s console.< / p >
< p > Check for unnecessary whitespace and correct indention of your resulting HTML.< / p >
< h2 id = "conventional-commits" > Conventional Commits< / h2 >
2024-04-21 21:48:09 +00:00
< p > Write commit messages in the < a href = "https://www.conventionalcommits.org/en/v1.0.0/" rel = "external" target = "_self" > conventional commit< / a > format.< / p >
2024-04-12 15:30:57 +00:00
< p > Following is an inpomplete list of some of the used conventional commit types. Be creative.< / p >
2023-01-28 13:49:11 +00:00
< table >
2024-09-03 17:09:09 +00:00
< thead >
< tr >
2024-10-24 14:30:52 +00:00
< th > Common< / th >
< th > Feature< / th >
< th > Structure< / th >
< th > Shortcodes< / th >
2024-09-03 17:09:09 +00:00
< / tr >
< / thead >
< tbody >
< tr >
2024-10-24 14:30:52 +00:00
< td > build< / td >
< td > a11y< / td >
< td > favicon< / td >
< td > attachments< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > browser< / td >
< td > archetypes< / td >
< td > search< / td >
< td > badge< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > chore< / td >
< td > alias< / td >
< td > menu< / td >
< td > button< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > docs< / td >
< td > generator< / td >
< td > history< / td >
< td > children< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > shortcodes< / td >
< td > i18n< / td >
< td > scrollbar< / td >
< td > expand< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > theme< / td >
< td > mobile< / td >
< td > nav< / td >
< td > icon< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > < / td >
< td > print< / td >
< td > toc< / td >
< td > include< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > < / td >
< td > rss< / td >
< td > clipboard< / td >
< td > math< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > < / td >
< td > variant< / td >
< td > syntaxhighlight< / td >
< td > mermaid< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > < / td >
< td > < / td >
< td > boxes< / td >
< td > notice< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > < / td >
< td > < / td >
< td > < / td >
< td > openapi< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > < / td >
< td > < / td >
< td > < / td >
< td > piratify< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > < / td >
< td > < / td >
< td > < / td >
< td > siteparam< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > < / td >
< td > < / td >
< td > < / td >
< td > tabs< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< / tbody >
2023-01-28 13:49:11 +00:00
< / table >
2024-10-13 14:26:50 +00:00
< footer class = "footline" >
< div class = "R-taxonomy taxonomy-categories cstyle" title = "Categories" style = "--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);" >
< i class = "fa-fw fas fa-layer-group" > < / i >
< ul >
< li > < a class = "term-link" href = "/hugo-theme-relearn/categories/explanation/index.html" > Explanation< / a > < / li >
< / ul >
< / div >
< / footer >
< / article >
< article class = "default" >
< header class = "headline" >
< / header >
2024-04-07 19:58:38 +00:00
2023-01-29 10:31:41 +00:00
< h1 id = "maintaining" > Maintaining< / h1 >
2023-01-28 13:49:11 +00:00
< h2 id = "semver" > Semver< / h2 >
2024-04-21 21:48:09 +00:00
< p > This project tries to follow the < a href = "https://semver.org/" rel = "external" target = "_self" > semver policy< / a > - although not followed 100% in the past.< / p >
2024-10-13 14:26:50 +00:00
< p > Usually an entry of < span class = "badge cstyle warning badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-triangle" > < / i > < / span > < span class = "badge-content" > Breaking< / span > < / span > on the < a href = "/hugo-theme-relearn/introduction/releasenotes/index.html" > What’ s new< / a > page causes a new major release number.< / p >
< p > All other entries on the < a href = "/hugo-theme-relearn/introduction/releasenotes/index.html" > What’ s new< / a > page will increase the minor release number.< / p >
2023-01-28 13:49:11 +00:00
< p > Releases resulting in a new major or minor number are called main release.< / p >
2024-10-13 14:26:50 +00:00
< p > Releases containing bugfixes only, are only increasing the patch release number. Those releases don’ t result in announcements on the < a href = "/hugo-theme-relearn/introduction/releasenotes/index.html" > What’ s new< / a > page.< / p >
< p > Entries on the < a href = "/hugo-theme-relearn/introduction/releasenotes/index.html" > What’ s new< / a > page are checked and enforced during the < code > version-release< / code > GitHub Action.< / p >
2023-01-28 13:49:11 +00:00
< h2 id = "managing-issues" > Managing Issues< / h2 >
2024-10-13 14:26:50 +00:00
< p > Issues are categorized and managed by assigning < a href = "/hugo-theme-relearn/development/maintaining/index.html#labels" > labels< / a > to it.< / p >
2023-01-28 13:49:11 +00:00
< p > Once working on an issue, assign it to a fitting maintainer.< / p >
< p > When done, close the ticket. Once an issue is closed, it needs to be assigned to next release milestone.< / p >
2023-01-30 15:55:08 +00:00
< p > A once released ticket is not allowed to be reopened and rereleased in a different milestone. This would cause the changelog to be changed even for the milestone the issue was previously released in. Instead write a new ticket.< / p >
2023-01-28 13:49:11 +00:00
< h2 id = "managing-pull-requests" > Managing Pull Requests< / h2 >
< p > If a PR is merged and closed it needs an accompanied issue assigned to. If there is no issue for a PR, the maintainer needs to create one.< / p >
< p > You can assign multiple PRs to one issue as long as they belong together.< / p >
< p > Usually set the same labels and milestone for the PR as for the accompanied issue.< / p >
< h2 id = "labels" > Labels< / h2 >
< h3 id = "kind" > Kind< / h3 >
< p > An issue that results in changesets must have exactly one of the following labels. This needs to be assigned latest before release.< / p >
< table >
2024-09-03 17:09:09 +00:00
< thead >
< tr >
2024-10-24 14:30:52 +00:00
< th > Label< / th >
< th > Description< / th >
< th > Changelog section< / th >
2024-09-03 17:09:09 +00:00
< / tr >
< / thead >
< tbody >
< tr >
2024-10-24 14:30:52 +00:00
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #5498d8;" > documentation< / span > < / span > < / td >
< td > Improvements or additions to documentation< / td >
< td > -< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #99d856;" > discussion< / span > < / span > < / td >
< td > This issue was converted to a discussion< / td >
< td > -< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #d8d104;" > task< / span > < / span > < / td >
< td > Maintenance work< / td >
< td > Maintenance< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #d8ae04;" > feature< / span > < / span > < / td >
< td > New feature or request< / td >
< td > Features< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #d88704;" > bug< / span > < / span > < / td >
< td > Something isn’ t working< / td >
< td > Fixes< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< / tbody >
2023-01-28 13:49:11 +00:00
< / table >
< h3 id = "impact" > Impact< / h3 >
2024-10-13 14:26:50 +00:00
< p > If the issue would cause a new main release due to < a href = "/hugo-theme-relearn/development/maintaining/index.html#semver" > semver semantics< / a > it needs one of the according labels and the matching badge on the < a href = "/hugo-theme-relearn/introduction/releasenotes/index.html" > What’ s new< / a > page.< / p >
2023-01-28 13:49:11 +00:00
< table >
2024-09-03 17:09:09 +00:00
< thead >
< tr >
2024-10-24 14:30:52 +00:00
< th > Label< / th >
< th > Description< / th >
2024-09-03 17:09:09 +00:00
< / tr >
< / thead >
< tbody >
< tr >
2024-10-24 14:30:52 +00:00
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #d73a4a;" > change< / span > < / span > < / td >
< td > Introduces changes with existing installations< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #d73a4a;" > breaking< / span > < / span > < / td >
< td > Introduces breaking changes with existing installations< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< / tbody >
2023-01-28 13:49:11 +00:00
< / table >
< h3 id = "declination" > Declination< / h3 >
< p > If an issue does not result in changesets but is closed anyways, it must have exactly one of the following labels.< / p >
< table >
2024-09-03 17:09:09 +00:00
< thead >
< tr >
2024-10-24 14:30:52 +00:00
< th > Label< / th >
< th > Description< / th >
2024-09-03 17:09:09 +00:00
< / tr >
< / thead >
< tbody >
< tr >
2024-10-24 14:30:52 +00:00
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #9fa2a5;" > duplicate< / span > < / span > < / td >
< td > This issue or pull request already exists< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #9fa2a5;" > invalid< / span > < / span > < / td >
< td > This doesn’ t seem right< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #9fa2a5;" > support< / span > < / span > < / td >
< td > Request for achieving a special goal< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #9fa2a5;" > unresolved< / span > < / span > < / td >
< td > No progress on this issue< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #9fa2a5;" > update< / span > < / span > < / td >
< td > A change in behavior after updat< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #9fa2a5;" > wontchange< / span > < / span > < / td >
< td > This will not be worked on< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< / tbody >
2023-01-28 13:49:11 +00:00
< / table >
< h3 id = "halt" > Halt< / h3 >
< p > You can assign one further label out of the following list to signal readers that development on an open issue is currently halted for different reasons.< / p >
< table >
2024-09-03 17:09:09 +00:00
< thead >
< tr >
2024-10-24 14:30:52 +00:00
< th > Label< / th >
< th > Description< / th >
2024-09-03 17:09:09 +00:00
< / tr >
< / thead >
< tbody >
< tr >
2024-10-24 14:30:52 +00:00
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #998f6b;" > blocked< / span > < / span > < / td >
< td > Depends on other issue to be fixed first< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #998f6b;" > idea< / span > < / span > < / td >
< td > A valuable idea that’ s currently not worked on< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #998f6b;" > undecided< / span > < / span > < / td >
< td > No decision was made yet< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #6426ff;" > helpwanted< / span > < / span > < / td >
< td > Great idea, send in a PR< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #6426ff;" > needsfeedback< / span > < / span > < / td >
< td > Further information is needed< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< / tbody >
2023-01-28 13:49:11 +00:00
< / table >
< h3 id = "3rd-party" > 3rd-Party< / h3 >
< p > If the issue is not caused by a programming error in the themes own code, you can label the causing program or library.< / p >
< table >
2024-09-03 17:09:09 +00:00
< thead >
< tr >
2024-10-24 14:30:52 +00:00
< th > Label< / th >
< th > Description< / th >
2024-09-03 17:09:09 +00:00
< / tr >
< / thead >
< tbody >
< tr >
2024-10-24 14:30:52 +00:00
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #e550a7;" > asciidoc< / span > < / span > < / td >
< td > This is a topic related to processing of AsciiDoc< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #e550a7;" > browser< / span > < / span > < / td >
< td > This is a topic related to the browser but not the theme< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #e550a7;" > device< / span > < / span > < / td >
< td > This is a topic related to a certain device< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #e550a7;" > hugo< / span > < / span > < / td >
< td > This is a topic related to Hugo itself but not the theme< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-24 14:30:52 +00:00
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #e550a7;" > mermaid< / span > < / span > < / td >
< td > This is a topic related to Mermaid itself but not the theme< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< / tbody >
2023-01-28 13:49:11 +00:00
< / table >
2024-10-13 14:26:50 +00:00
< h2 id = "setting-up-a-development-environment" > Setting Up a Development Environment< / h2 >
< p > Git Hooks are used to automate some tasks. They are stored in the < code > .githooks< / code > root folder.< / p >
< p > Documentation for each hook is contained in each file.< / p >
< p > At least the < code > pre-commit< / code > hook is required, as it updates the version number on each commit. This helps to help debugging of user related issues.< / p >
2023-01-28 13:49:11 +00:00
< h2 id = "making-releases" > Making Releases< / h2 >
2024-10-13 14:26:50 +00:00
< p > A release is based on a milestone named like the release itself - just the version number, eg: < code > 1.2.3< / code > . It’ s in the maintainers responsibility to check < a href = "/hugo-theme-relearn/development/maintaining/index.html#semver" > semver semantics< / a > of the milestone’ s name prior to release and change it if necessary.< / p >
2023-01-28 13:49:11 +00:00
< p > Making releases is automated by the < code > version-release< / code > GitHub Action. It requires the version number of the milestone that should be released. The release will be created from the < code > main< / code > branch of the repository.< / p >
2023-01-30 15:55:08 +00:00
< p > Treat released milestones as immutable. Don’ t rerelease an already released milestone. An already released milestone may already been consumed by your users.< / p >
2023-01-28 13:49:11 +00:00
< p > During execution of the action a few things are checked. If a check fails the action fails, resulting in no new release. You can correct the errors afterwards and rerun the action.< / p >
< p > The following checks will be enforced< / p >
< ul >
< li > the milestone exists< / li >
< li > there is at least one closed issue assigned to the milestone< / li >
< li > all assigned issues for this milestone are closed< / li >
2024-10-13 14:26:50 +00:00
< li > if it’ s a main release, there must be an accompanying releasenotes file present in the repo at < code > introduction/releasenotes/< major> /< minor> .en.md< / code > < / li >
2023-01-28 13:49:11 +00:00
< / ul >
< p > After a successful run of the action< / p >
< ul >
2024-10-13 14:26:50 +00:00
< li > the changelog at < code > introduction/changelog/< major> /< minor> /< patch> .< lang> .md< / code > is created for english and piratish, including missing generic upper level files< / li >
< li > the < code > CHANGELOG.md< / code > is updated< / li >
< li > the releasenotes at < code > introduction/releasenotes/< major> /< minor> .en.md< / code > are updated, including release version and release date< / li >
< li > missing generic upper level files for english and piratish are created< / li >
2023-01-28 13:49:11 +00:00
< li > the version number for the < code > < meta generator> < / code > is updated< / li >
2024-02-24 12:55:20 +00:00
< li > the updated files are committed< / li >
2023-01-28 13:49:11 +00:00
< li > the milestone is closed< / li >
2023-01-30 11:58:02 +00:00
< li > the repository is tagged with the version number (eg. < code > 1.2.3< / code > ), the main version number (eg. < code > 1.2.x< / code > ) and the major version number (eg. < code > 1.x< / code > )< / li >
2024-04-21 21:48:09 +00:00
< li > a new entry in the < a href = "https://github.com/McShelby/hugo-theme-relearn/releases" rel = "external" target = "_self" > GitHub release list< / a > with the according changelog will be created< / li >
2024-10-13 14:26:50 +00:00
< li > the < a href = "https://mcshelby.github.io/hugo-theme-relearn/" rel = "external" target = "_self" > official documentation< / a > is built and deployed< / li >
2024-02-24 12:55:20 +00:00
< li > the version number for the < code > < meta generator> < / code > is updated to a temporary and committed (this helps to determine if users are running directly on the main branch or are using releases)< / li >
2023-01-28 13:49:11 +00:00
< li > a new milestone for the next patch release is created (this can later be renamed to a main release if necessary)< / li >
< / ul >
2024-10-13 14:26:50 +00:00
< footer class = "footline" >
< div class = "R-taxonomy taxonomy-categories cstyle" title = "Categories" style = "--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);" >
< i class = "fa-fw fas fa-layer-group" > < / i >
< ul >
< li > < a class = "term-link" href = "/hugo-theme-relearn/categories/explanation/index.html" > Explanation< / a > < / li >
< li > < a class = "term-link" href = "/hugo-theme-relearn/categories/howto/index.html" > Howto< / a > < / li >
< / ul >
< / div >
< / footer >
< / article >
< article class = "default" >
< header class = "headline" >
< / header >
2024-04-07 19:58:38 +00:00
2023-01-24 22:59:44 +00:00
< h1 id = "screenshots" > Screenshots< / h1 >
< p > Sometimes screenshots need to be redone. This page explains how to create the different screenshots, tools and settings< / p >
< h2 id = "common" > Common< / h2 >
2023-01-28 10:59:37 +00:00
< p > < strong > Creation< / strong > :< / p >
2023-01-24 22:59:44 +00:00
< ul >
< li > Use English translation< / li >
< li > Empty search< / li >
< li > Remove history checkmarks but leave it on the page thats used for the screenshot< / li >
2023-01-28 10:59:37 +00:00
< li > After resize of the page into the required resolution, reload the page to have all scrollbars in default loading position< / li >
2023-01-24 22:59:44 +00:00
< / ul >
2023-01-28 10:59:37 +00:00
< h2 id = "demo-screenshot" > Demo Screenshot< / h2 >
2023-01-24 22:59:44 +00:00
< p > < strong > Content< / strong > :< / p >
< p > A meaningful full-screen screenshot of an interesting page.< / p >
< p > The content should be:< / p >
< ul >
< li > timeless: not showing any dates or often edited content< / li >
< li > interesting: show a bunch of interesting elements like headings, code, etc< / li >
< li > balanced: no cluttering with overpresent elements or coloring< / li >
< li > aligned: aligned outlines< / li >
< / ul >
< p > < strong > Used by< / strong > :< / p >
< ul >
2024-09-12 17:49:38 +00:00
< li > Hugo Themes info: < a href = "https://themes.gohugo.io/themes/hugo-theme-relearn/" rel = "external" target = "_self" > https://themes.gohugo.io/themes/hugo-theme-relearn/< / a > < em > 1000 x 1500 @ 1< / em > (< code > images/screenshot.png< / code > )< / li >
< li > Hugo Themes gallery: < a href = "https://themes.gohugo.io/tags/docs/" rel = "external" target = "_self" > https://themes.gohugo.io/tags/docs/< / a > < em > 900 x 600< / em > @ 1 (< code > images/tn.png< / code > )< / li >
2023-01-24 22:59:44 +00:00
< / ul >
2024-02-24 12:50:21 +00:00
< p > < strong > Page URL< / strong > : < a href = "/hugo-theme-relearn/shortcodes/notice/index.html" > Screenshot Link< / a > < / p >
2023-01-25 20:34:46 +00:00
< p > < strong > Creation< / strong > :< / p >
< ul >
< li > save as < code > images/screenshot.png< / code > < / li >
2024-09-12 17:49:38 +00:00
< li > from original screenshot, scale to < em > 900 x 600< / em > and save as < code > images/tn.png< / code > < / li >
2023-01-25 20:34:46 +00:00
< / ul >
2023-01-24 22:59:44 +00:00
< p > < strong > Remarks< / strong > :< / p >
2024-09-12 17:49:38 +00:00
< p > The locations are mandatory due to Hugo’ s theme site builder.< / p >
2023-10-11 11:17:41 +00:00
< p > < strong > Preview< / strong > < code > images/screenshot.png< / code > :< / p >
2024-11-17 23:21:01 +00:00
< p > < a href = "#R-image-551ab78b64e2957b957fc757769c9c74" class = "lightbox-link" > < img alt = "Screenshot" class = "bg-white border lazy lightbox noshadow figure-image" loading = "lazy" src = "/hugo-theme-relearn/images/screenshot.png?width=50%25&height=50%25" style = " height: 50%; width: 50%;" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-551ab78b64e2957b957fc757769c9c74" > < img alt = "Screenshot" class = "bg-white border lazy lightbox noshadow lightbox-image" loading = "lazy" src = "/hugo-theme-relearn/images/screenshot.png?width=50%25&height=50%25" > < / a > < / p >
2024-09-12 17:49:38 +00:00
< p > < strong > Preview< / strong > < code > images/tn.png< / code > :< / p >
2024-11-17 23:21:01 +00:00
< p > < a href = "#R-image-74298761f137dccc84da4644c76ec4e9" class = "lightbox-link" > < img alt = "tn" class = "bg-white border lazy lightbox noshadow figure-image" loading = "lazy" src = "/hugo-theme-relearn/images/tn.png?width=50%25&height=50%25" style = " height: 50%; width: 50%;" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-74298761f137dccc84da4644c76ec4e9" > < img alt = "tn" class = "bg-white border lazy lightbox noshadow lightbox-image" loading = "lazy" src = "/hugo-theme-relearn/images/tn.png?width=50%25&height=50%25" > < / a > < / p >
2023-01-24 22:59:44 +00:00
< h2 id = "hero-image" > Hero Image< / h2 >
< p > < strong > Content< / strong > :< / p >
2024-10-13 14:26:50 +00:00
< p > Show the < a href = "/hugo-theme-relearn/development/screenshots/index.html#demo-screenshot" > Demo Screenshot< / a > page on different devices and different themes. Composition of the different device screenshots into a template.< / p >
2023-01-25 20:34:46 +00:00
< p > The content should be:< / p >
2023-01-24 22:59:44 +00:00
< ul >
2023-01-25 20:34:46 +00:00
< li > consistent: always use the same page for all devices< / li >
< li > pleasing: use a delightful background< / li >
2023-01-24 22:59:44 +00:00
< / ul >
< p > < strong > Used by< / strong > :< / p >
< ul >
2024-04-21 21:48:09 +00:00
< li > Hugo Themes notes: < a href = "https://themes.gohugo.io/themes/hugo-theme-relearn/" rel = "external" target = "_self" > https://themes.gohugo.io/themes/hugo-theme-relearn/< / a > < em > 1280 x 640< / em > < / li >
< li > GitHub project site: < a href = "https://github.com/McShelby/hugo-theme-relearn" rel = "external" target = "_self" > https://github.com/McShelby/hugo-theme-relearn< / a > < em > 1280 x 640< / em > < / li >
< li > GitHub social media preview: < a href = "https://github.com/McShelby/hugo-theme-relearn/settings" rel = "external" target = "_self" > https://github.com/McShelby/hugo-theme-relearn/settings< / a > < em > 1280 x 640< / em > < / li >
2023-01-24 22:59:44 +00:00
< / ul >
2024-02-24 12:50:21 +00:00
< p > < strong > Page URL< / strong > : < a href = "/hugo-theme-relearn/shortcodes/notice/index.html" > Hero Image Link< / a > < / p >
2023-01-24 22:59:44 +00:00
< p > < strong > Creation< / strong > :< / p >
< ul >
2024-04-21 21:48:09 +00:00
< li > Template: < a href = "http://www.pixeden.com/psd-web-elements/psd-screen-web-showcase" rel = "external" target = "_self" > http://www.pixeden.com/psd-web-elements/psd-screen-web-showcase< / a > < / li >
2023-01-24 22:59:44 +00:00
< li > Desktop: light theme < em > 1440 x 900 @ 1< / em > < / li >
< li > Tablet: light theme < em > 778 x 1038 @ 1< / em > < / li >
< li > Phone: dark theme < em > 450 x 801 @ .666< / em > < / li >
2024-09-12 17:49:38 +00:00
< li > From original template resize to < em > 3000 x 1500< / em > offset y: < em > -330< / em > , scale to < em > 1280 x 640< / em > and save as < code > images/hero.png< / code > < / li >
2023-01-24 22:59:44 +00:00
< / ul >
2023-10-11 11:17:41 +00:00
< p > < strong > Preview< / strong > < code > images/hero.png< / code > :< / p >
2024-11-17 23:21:01 +00:00
< p > < a href = "#R-image-fc862bdd5257582a56fbb1e682a780c5" class = "lightbox-link" > < img alt = "Hero" class = "bg-white border lazy lightbox noshadow figure-image" loading = "lazy" src = "/hugo-theme-relearn/images/hero.png?width=50%25&height=50%25" style = " height: 50%; width: 50%;" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-fc862bdd5257582a56fbb1e682a780c5" > < img alt = "Hero" class = "bg-white border lazy lightbox noshadow lightbox-image" loading = "lazy" src = "/hugo-theme-relearn/images/hero.png?width=50%25&height=50%25" > < / a > < / p >
2023-01-24 22:59:44 +00:00
2024-10-13 14:26:50 +00:00
< footer class = "footline" >
< div class = "R-taxonomy taxonomy-categories cstyle" title = "Categories" style = "--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);" >
< i class = "fa-fw fas fa-layer-group" > < / i >
< ul >
< li > < a class = "term-link" href = "/hugo-theme-relearn/categories/explanation/index.html" > Explanation< / a > < / li >
< li > < a class = "term-link" href = "/hugo-theme-relearn/categories/howto/index.html" > Howto< / a > < / li >
< / ul >
< / div >
< / footer >
< / article >
2023-05-17 22:13:41 +00:00
< / section >
< / div >
2023-01-24 22:59:44 +00:00
< / main >
< / div >
2024-11-17 23:21:01 +00:00
< script src = "/hugo-theme-relearn/js/clipboard.min.js?1731885648" defer > < / script >
< script src = "/hugo-theme-relearn/js/perfect-scrollbar.min.js?1731885648" defer > < / script >
< script src = "/hugo-theme-relearn/js/theme.js?1731885648" defer > < / script >
2023-01-24 22:59:44 +00:00
< / body >
< / html >
