2023-01-24 22:59:44 +00:00
<!DOCTYPE html>
2023-11-28 21:01:15 +00:00
< html lang = "art-pir" dir = "rtl" >
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-03-11 20:44:09 +00:00
< meta name = "generator" content = "Hugo 0.123.8" >
2024-03-16 09:14:43 +00:00
< meta name = "generator" content = "Relearn 5.26.0+tip" >
2023-01-24 22:59:44 +00:00
< meta name = "robots" content = "noindex, nofollow, noarchive, noimageindex" >
< meta name = "description" content = "Documentation for Hugo Relearn 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 :: Cap'n Hugo Relearrrn Theme" >
< meta name = "twitter:description" content = "Documentation for Hugo Relearn Theme" >
2023-10-11 15:32:39 +00:00
< meta property = "og:title" content = "Development :: Cap'n Hugo Relearrrn Theme" >
< meta property = "og:description" content = "Documentation for Hugo Relearn Theme" >
< meta property = "og:type" content = "website" >
2024-02-24 13:03:50 +00:00
< meta property = "og:url" content = "https://mcshelby.github.io/hugo-theme-relearn/pir/dev/index.html" >
< meta property = "og:image" content = "https://mcshelby.github.io/hugo-theme-relearn/images/hero.png" >
2023-10-11 15:32:39 +00:00
< meta property = "og:site_name" content = "Cap'n Hugo Relearrrn Theme" >
2023-01-24 22:59:44 +00:00
< title > Development :: Cap' n Hugo Relearrrn Theme< / title >
2024-02-24 13:03:50 +00:00
< link href = "https://mcshelby.github.io/hugo-theme-relearn/dev/index.html" rel = "alternate" hreflang = "x-default" >
< link href = "https://mcshelby.github.io/hugo-theme-relearn/dev/index.html" rel = "alternate" hreflang = "en" >
< link href = "https://mcshelby.github.io/hugo-theme-relearn/pir/dev/index.html" rel = "alternate" hreflang = "art-pir" >
2024-03-16 11:57:28 +00:00
< link href = "/hugo-theme-relearn/images/logo.svg?1710590241" rel = "icon" type = "image/svg+xml" >
2023-01-24 22:59:44 +00:00
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how - to - use -->
2024-03-16 11:57:28 +00:00
< link href = "/hugo-theme-relearn/css/fontawesome-all.min.css?1710590244" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/fontawesome-all.min.css?1710590244" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/nucleus.css?1710590244" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/auto-complete.css?1710590244" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/auto-complete.css?1710590244" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/perfect-scrollbar.min.css?1710590244" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/fonts.css?1710590244" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/fonts.css?1710590244" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/theme.css?1710590244" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/theme-relearn-auto.css?1710590244" rel = "stylesheet" id = "R-variant-style" >
< link href = "/hugo-theme-relearn/css/chroma-relearn-auto.css?1710590244" rel = "stylesheet" id = "R-variant-chroma-style" >
< link href = "/hugo-theme-relearn/css/variant.css?1710590244" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/print.css?1710590244" rel = "stylesheet" media = "print" >
< link href = "/hugo-theme-relearn/css/format-print.css?1710590244" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/ie.css?1710590244" rel = "stylesheet" >
< script src = "/hugo-theme-relearn/js/url.js?1710590244" > < / script >
< script src = "/hugo-theme-relearn/js/variant.js?1710590244" > < / script >
2023-01-24 22:59:44 +00:00
< script >
// hack to let hugo tell us how to get to the root when using relativeURLs, it needs to be called *url= for it to do its magic:
// https://github.com/gohugoio/hugo/blob/145b3fcce35fbac25c7033c91c1b7ae6d1179da8/transform/urlreplacers/absurlreplacer.go#L72
2024-02-24 12:50:21 +00:00
window.index_js_url="/hugo-theme-relearn/pir/index.search.js";
var root_url="/";
2023-11-16 22:53:34 +00:00
window.relearn = window.relearn || {};
2024-03-16 11:57:28 +00:00
window.relearn.baseUri=root_url.replace(/\/$/, '');
2024-02-24 13:03:50 +00:00
window.relearn.baseUriFull='https:\/\/mcshelby.github.io\/hugo-theme-relearn/';
2023-11-16 22:53:34 +00:00
// variant stuff
2023-12-03 14:23:32 +00:00
window.relearn.themeVariantModifier='';
2023-11-23 00:05:57 +00:00
window.variants & & variants.init( [ 'relearn-auto', 'relearn-light', 'relearn-dark', 'relearn-bright', 'zen-auto', 'zen-light', 'zen-dark', 'neon', 'learn', 'blue', 'green', 'red' ] );
2023-11-16 22:53:34 +00:00
// translations
window.T_Copy_to_clipboard = `Copy t' clipboard`;
window.T_Copied_to_clipboard = `Copied t' clipboard!`;
window.T_Copy_link_to_clipboard = `Copy link t' clipboard`;
window.T_Link_copied_to_clipboard = `Copied link t' clipboard!`;
window.T_Reset_view = `Rrreset view`;
window.T_View_reset = `View rrreset!`;
window.T_No_results_found = `No rrresults found fer "{0}"`;
window.T_N_results_found = `{1} rrresults found fer "{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-02-24 12:50:21 +00:00
< body class = "mobile-support print disableInlineCopyToClipboard" data-url = "/hugo-theme-relearn/pir/dev/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 >
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" >
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 >
< main id = "R-body-inner" class = "highlightable chapter narrow" tabindex = "-1" >
2023-01-24 22:59:44 +00:00
< div class = "flex-block-wrapper" >
< article class = "chapter" >
2023-05-19 18:46:07 +00:00
< header class = "headline" >
< / header >
2023-01-24 22:59:44 +00:00
< div class = "article-subheading" > T' chapterrr 4< / div >
< h1 id = "development" > Development< / h1 >
< p > This chapter contains informat'n only needed fer development an' maintain'n th' theme.< / p >
2023-06-03 20:59:23 +00:00
2023-01-24 22:59:44 +00:00
< div class = "children children-h2 children-sort-" >
2023-06-03 20:59:23 +00:00
2024-02-24 14:10:30 +00:00
< h2 > < a href = "/hugo-theme-relearn/pir/dev/contributing/index.html" > Contribut'n< / a > < / h2 > < p > What t' know if ye want t' contribute< / p >
< h2 > < a href = "/hugo-theme-relearn/pir/dev/maintaining/index.html" > Maintain'n< / a > < / h2 > < p > What t' know as a maintainer< / p >
< h2 > < a href = "/hugo-theme-relearn/pir/dev/screenshots/index.html" > Screenshots< / a > < / h2 > < p > Recipe t' create various documentat'n screenshots< / p >
2023-01-24 22:59:44 +00:00
< / div >
< footer class = "footline" >
< / footer >
< / article >
< section >
< h1 class = "a11y-only" > Subsct' ns o' Development< / h1 >
< article class = "default" >
2023-05-19 18:46:07 +00:00
< header class = "headline" >
< / header >
2023-01-28 13:49:11 +00:00
< h1 id = "contributing" > Contributing< / h1 >
< h2 id = "code-quality" > Code Quality< / h2 >
2023-10-28 20:28:18 +00:00
< p > A new release can happen at any time from th' < code > main< / code > branch o' th' < a href = "https://github.com/McShelby/hugo-theme-relearn" target = "_blank" > GitHub project< / a > without further accknowledgment. This makes it necessary that, every pushed set o' changesets into th' < code > main< / code > branch < strong > must< / strong > be self-contained an' correct, result'n 'n a releas'ble version.< / p >
2023-01-28 13:49:11 +00:00
< p > Stay simple fer th' user by focus'n on th' mantra “ convent'n over configuration” .< / p >
< p > At installat'n th' ship should work reason'ble without (m)any configurat'n.< / p >
< p > Stay close t' th' Cap'n Hugo way.< / p >
< p > Don’ t use npm or any preprocess'n, our contributors may not be front-end developers.< / p >
2024-02-24 14:10:30 +00:00
< p > Document new features 'n th' exampleSite. This also contains entries t' th' < a href = "/hugo-theme-relearn/pir/basics/migration/index.html" > What’ s new< / a > plank.< / p >
2023-01-28 13:49:11 +00:00
< p > Don’ t break exist'n features if ye don’ t have t'.< / p >
< p > Remove reported issue from th' browser’ s console.< / p >
< p > Check fer unnecessary whitespace an' correct indent'n o' yer result'n HTML.< / p >
< p > Be compat'ble t' IE11, at least fer main functionality, this means:< / p >
< ul >
< li > test 'n IE11< / li >
< li > check caniuse.com< / li >
< li > don’ t use JavaScript arrow funct'ns< / li >
< li > don’ t use JavaScript template literals< / li >
< li > don’ t use other fancy JavaScript ES5/6 stuff< / li >
< / ul >
< h2 id = "conventional-commits" > Conventional Commits< / h2 >
2023-10-28 20:28:18 +00:00
< p > Write commit messages 'n th' < a href = "https://www.conventionalcommits.org/en/v1.0.0/" target = "_blank" > conventional commit< / a > format.< / p >
2023-01-28 13:49:11 +00:00
< p > Follow'n be an impomplete list o' some o' th' used conventional commit types. Be creative.< / p >
< table >
< thead >
< tr >
< th > Common< / th >
< th > Feature< / th >
< th > Structure< / th >
< th > Shorrrtcodes< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > build< / td >
< td > a11y< / td >
< td > favicon< / td >
< td > attachments< / td >
< / tr >
< tr >
< td > browser< / td >
< td > archetypes< / td >
< td > search< / td >
< td > badge< / td >
< / tr >
< tr >
< td > chore< / td >
< td > alias< / td >
< td > menu< / td >
< td > button< / td >
< / tr >
< tr >
< td > docs< / td >
< td > generator< / td >
< td > history< / td >
< td > children< / td >
< / tr >
< tr >
< td > shorrrtcodes< / td >
< td > i18n< / td >
< td > scrollbar< / td >
< td > expand< / td >
< / tr >
< tr >
< td > theme< / td >
< td > mobile< / td >
< td > nav< / td >
< td > ay'con< / td >
< / tr >
< tr >
< td > < / td >
< td > print< / td >
< td > toc< / td >
< td > include< / td >
< / tr >
< tr >
< td > < / td >
< td > rss< / td >
< td > clipboard< / td >
< td > math< / td >
< / tr >
< tr >
< td > < / td >
< td > variant< / td >
< td > syntaxhighlight< / td >
< td > mermaid< / td >
< / tr >
< tr >
< td > < / td >
< td > < / td >
< td > boxes< / td >
< td > notice< / td >
< / tr >
< tr >
< td > < / td >
< td > < / td >
< td > < / td >
2023-05-14 21:06:26 +00:00
< td > openapi< / td >
2023-01-28 13:49:11 +00:00
< / tr >
< tr >
< td > < / td >
< td > < / td >
< td > < / td >
2023-05-14 21:06:26 +00:00
< td > piratify< / td >
2023-01-28 13:49:11 +00:00
< / tr >
< tr >
< td > < / td >
< td > < / td >
< td > < / td >
2023-05-14 21:06:26 +00:00
< td > siteparam< / td >
2023-01-28 13:49:11 +00:00
< / tr >
< tr >
< td > < / td >
< td > < / td >
< td > < / td >
< td > tabs< / td >
< / tr >
< / tbody >
< / table >
< footer class = "footline" >
< / footer >
< / article >
< article class = "default" >
2023-05-19 18:46:07 +00:00
< header class = "headline" >
< / header >
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 >
2023-10-28 20:28:18 +00:00
< p > This project tries t' follow th' < a href = "https://semver.org/" target = "_blank" > semver policy< / a > - although not followed 100% 'n th' past.< / p >
2024-02-24 14:10:30 +00:00
< p > Usually an entry o' < 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" > Break'n< / span > < / span > on th' < a href = "/hugo-theme-relearn/pir/basics/migration/index.html" > What’ s new< / a > plank causes a new major release number.< / p >
< p > All other entries on th' < a href = "/hugo-theme-relearn/pir/basics/migration/index.html" > What’ s new< / a > plank will increase th' minor release number.< / p >
2023-01-28 13:49:11 +00:00
< p > Releases result'n 'n a new major or minor number be called main release.< / p >
2024-02-24 14:10:30 +00:00
< p > Releases contain'n bugixes only, be only increas'n th' patch release number. Those releases don’ t result 'n announcements on th' < a href = "/hugo-theme-relearn/pir/basics/migration/index.html" > What’ s new< / a > plank.< / p >
< p > Entries on th' < a href = "/hugo-theme-relearn/pir/basics/migration/index.html" > What’ s new< / a > plank be checked an' enforced dur'n th' < code > version-release< / code > GitHub Act'n.< / p >
2023-01-28 13:49:11 +00:00
< h2 id = "managing-issues" > Manag'n Issues< / h2 >
2024-02-24 14:10:30 +00:00
< p > Issues be categorized an' managed by assign'n < a href = "/hugo-theme-relearn/pir/dev/maintaining/index.html#labels" > labels< / a > t' it.< / p >
2023-01-28 13:49:11 +00:00
< p > Once work'n on an issue, assign it t' a fitt'n maintainer.< / p >
< p > When done, close th' ticket. Once an issue be closed, it needs t' be assigned t' next release milestone.< / p >
2023-01-30 15:55:08 +00:00
< p > A once released ticket be not allowed t' be reopened an' rereleased 'n a different milestone. This would cause th' changelog t' be changed even fer th' milestone th' issue was previously released 'n. Instead write a new ticket.< / p >
2023-01-28 13:49:11 +00:00
< h2 id = "managing-pull-requests" > Manag'n Pull Requests< / h2 >
< p > If a PR be merged an' closed it needs an accompanied issue assigned t'. If there be no issue fer a PR, th' maintainer needs t' create one.< / p >
< p > Ye can assign multiple PRs t' one issue as long as they belong together.< / p >
< p > Usually set th' same labels an' milestone fer th' PR as fer th' accompanied issue.< / p >
< h2 id = "labels" > Labels< / h2 >
< h3 id = "kind" > Kind< / h3 >
< p > An issue that results 'n changesets must have exactly one o' th' follow'n labels. This needs t' be assigned latest before release.< / p >
< table >
< thead >
< tr >
< th > Label< / th >
< th > Descript'n< / th >
< th > Changelog section< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #5498d8;" > documentat'n< / span > < / span > < / td >
< td > Improvements or addit'ns t' documentat'n< / td >
< td > -< / td >
< / tr >
< tr >
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #99d856;" > discussion< / span > < / span > < / td >
< td > This issue was converted t' a discussion< / td >
< td > -< / td >
< / tr >
< tr >
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #d8d104;" > task< / span > < / span > < / td >
2024-02-24 12:55:20 +00:00
< td > Maintenance work< / td >
2023-01-28 13:49:11 +00:00
< td > Maintenance< / td >
< / tr >
< tr >
< 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 >
< / tr >
< tr >
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #d88704;" > bug< / span > < / span > < / td >
< td > Someth'n isn’ t work'n< / td >
< td > Fixes< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "impact" > Impact< / h3 >
2024-02-24 14:10:30 +00:00
< p > If th' issue would cause a new main release due t' < a href = "/hugo-theme-relearn/pir/dev/maintaining/index.html#semver" > semver semantics< / a > it needs one o' th' accord'n labels an' th' match'n badge on th' < a href = "/hugo-theme-relearn/pir/basics/migration/index.html" > What’ s new< / a > plank.< / p >
2023-01-28 13:49:11 +00:00
< table >
< thead >
< tr >
< th > Label< / th >
< th > Descript'n< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #d73a4a;" > change< / span > < / span > < / td >
< td > Introduces changes wit' exist'n installat'ns< / td >
< / tr >
< tr >
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #d73a4a;" > break'n< / span > < / span > < / td >
< td > Introduces break'n changes wit' exist'n installat'ns< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "declination" > Declinat'n< / h3 >
< p > If an issue does not result 'n changesets but be closed anyways, it must have exactly one o' th' follow'n labels.< / p >
< table >
< thead >
< tr >
< th > Label< / th >
< th > Descript'n< / th >
< / tr >
< / thead >
< tbody >
< tr >
< 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 >
< / tr >
< tr >
< 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 >
< / tr >
< tr >
2023-11-12 12:44:57 +00:00
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #9fa2a5;" > support< / span > < / span > < / td >
< td > Solved by reconfigur'n th' authors ship< / td >
< / tr >
< tr >
2023-01-28 13:49:11 +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 >
< / tr >
< tr >
2023-02-17 15:00:25 +00:00
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #9fa2a5;" > update< / span > < / span > < / td >
< td > A documented change 'n behaviour< / td >
< / tr >
< tr >
2023-01-28 13:49:11 +00:00
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #9fa2a5;" > wontfix< / span > < / span > < / td >
< td > This will not be worked on< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "halt" > Halt< / h3 >
< p > Ye can assign one further label out o' th' follow'n list t' signal readers that development on an open issue be currently halted fer different reasons.< / p >
< table >
< thead >
< tr >
< th > Label< / th >
< th > Descript'n< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #998f6b;" > blocked< / span > < / span > < / td >
< td > Depends on other issue t' be fixed first< / td >
< / tr >
< tr >
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #998f6b;" > idea< / span > < / span > < / td >
< td > A valu'ble idea that’ s currently not worked on< / td >
< / tr >
< tr >
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #998f6b;" > undecided< / span > < / span > < / td >
2024-02-24 12:55:20 +00:00
< td > No decision was made yet< / td >
2023-01-28 13:49:11 +00:00
< / tr >
< tr >
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #6426ff;" > helpwanted< / span > < / span > < / td >
< td > Great idea, send 'n a PR< / td >
< / tr >
< tr >
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #6426ff;" > needsfeedback< / span > < / span > < / td >
< td > Further informat'n be needed< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "3rd-party" > 3rd-Party< / h3 >
< p > If th' issue be not caused by a programm'n error 'n th' themes own code, ye can label th' caus'n program or library.< / p >
< table >
< thead >
< tr >
< th > Label< / th >
< th > Descript'n< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #e550a7;" > browser< / span > < / span > < / td >
< td > This be a topic related t' th' browser but not th' theme< / td >
< / tr >
< tr >
2023-02-21 18:53:18 +00:00
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #e550a7;" > device< / span > < / span > < / td >
< td > This be a topic related t' a certain device< / td >
< / tr >
< tr >
2023-01-28 13:49:11 +00:00
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #e550a7;" > hugo< / span > < / span > < / td >
< td > This be a topic related t' Cap'n Hugo itself but not th' theme< / td >
< / tr >
< tr >
< td > < span class = "badge cstyle default" > < span class = "badge-content" style = "background-color: #e550a7;" > mermaid< / span > < / span > < / td >
< td > This be a topic related t' Merrrmaid itself but not th' theme< / td >
< / tr >
< / tbody >
< / table >
< h2 id = "making-releases" > Mak'n Releases< / h2 >
2024-02-24 14:10:30 +00:00
< p > A release be based on a milestone named like th' release itself - just th' version number, eg: < code > 1.2.3< / code > . It’ s 'n th' maintainers responsibility t' check < a href = "/hugo-theme-relearn/pir/dev/maintaining/index.html#semver" > semver semantics< / a > o' th' milestone’ s name prior t' release an' change it if necessary.< / p >
2023-01-28 13:49:11 +00:00
< p > Mak'n releases be automated by th' < code > version-release< / code > GitHub Act'n. It requires th' version number o' th' milestone that should be released. Th' release will be created from th' < code > main< / code > branch o' th' repository.< / p >
2023-01-30 15:55:08 +00:00
< p > Treat released milestones as immut'ble. Don’ t rerelease an already released milestone. An already released milestone may already been consumed by yer users.< / p >
2023-01-28 13:49:11 +00:00
< p > Dur'n execut'n o' th' act'n a few th'ns be checked. If a check fails th' act'n fails, result'n 'n no new release. Ye can correct th' errors afterwards an' rerun th' act'n.< / p >
< p > Th' follow'n checks will be enforced< / p >
< ul >
< li > th' milestone exists< / li >
< li > there be at least one closed issue assigned t' th' milestone< / li >
< li > all assigned issues fer this milestone be closed< / li >
2024-02-24 14:10:30 +00:00
< li > if it’ s a main release, there must be a new < code > < major> .< minor> < / code > at th' beginn'n o' th' < a href = "/hugo-theme-relearn/pir/basics/migration/index.html" > What’ s new< / a > plank< / li >
< li > if it’ s a patch release, there must be th' < code > < major> .< minor> < / code > from th' previous release at th' beginn'n o' th' < a href = "/hugo-theme-relearn/pir/basics/migration/index.html" > What’ s new< / a > plank< / li >
2023-01-28 13:49:11 +00:00
< / ul >
< p > Aft a successful run o' th' act'n< / p >
< ul >
2023-10-28 20:28:18 +00:00
< li > th' < a href = "https://mcshelby.github.io/hugo-theme-relearn/basics/history/index.html" target = "_blank" > History< / a > plank be updated, includ'n release version, release date an' text< / li >
< li > th' < a href = "https://mcshelby.github.io/hugo-theme-relearn/basics/migration/index.html" target = "_blank" > What’ s new< / a > plank be updated, includ'n release version, release date an' text< / li >
2023-01-28 13:49:11 +00:00
< li > th' version number fer th' < code > < meta generator> < / code > be updated< / li >
2024-02-24 12:55:20 +00:00
< li > th' updated files be committed< / li >
2023-01-28 13:49:11 +00:00
< li > th' milestone be closed< / li >
2023-01-30 11:58:02 +00:00
< li > th' repository be tagged wit' th' version number (eg. < code > 1.2.3< / code > ), th' main version number (eg. < code > 1.2.x< / code > ) an' th' major version number (eg. < code > 1.x< / code > )< / li >
2023-10-28 20:28:18 +00:00
< li > a new entry 'n th' < a href = "https://github.com/McShelby/hugo-theme-relearn/releases" target = "_blank" > GitHub release list< / a > wit' th' accord'n changelog will be created< / li >
< li > th' < a href = "https://mcshelby.github.io/hugo-theme-relearn/index.html" target = "_blank" > official documentat'n< / a > be built an' deployed< / li >
2024-02-24 12:55:20 +00:00
< li > th' version number fer th' < code > < meta generator> < / code > be updated t' a temporary an' committed (this helps t' determine if users be runn'n directly on th' main branch or be us'n releases)< / li >
2023-01-28 13:49:11 +00:00
< li > a new milestone fer th' next patch release be created (this can later be renamed t' a main release if necessary)< / li >
< / ul >
< footer class = "footline" >
< / footer >
< / article >
< article class = "default" >
2023-05-19 18:46:07 +00:00
< header class = "headline" >
< / header >
2023-01-24 22:59:44 +00:00
< h1 id = "scrrrenshots" > Scrrrenshots< / h1 >
< p > Sometimes screenshots need t' be redone. This plank explains how t' create th' different screenshots, tools an' sett'ns< / p >
< h2 id = "common" > Common< / h2 >
2023-01-28 10:59:37 +00:00
< p > < strong > Creat'n< / strong > :< / p >
2023-01-24 22:59:44 +00:00
< ul >
< li > Use English translat'n< / li >
< li > Empty search< / li >
< li > Remove history checkmarks but leave it on th' plank thats used fer th' screenshot< / li >
2023-01-28 10:59:37 +00:00
< li > Aft resize o' th' plank into th' required resolut'n, reload th' plank t' have all scrollbars 'n default load'n posit'n< / 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 > Rrrambl'n< / strong > :< / p >
< p > A meaningful full-screen screenshot o' an interest'n plank.< / p >
< p > Th' rrrambl'n should be:< / p >
< ul >
< li > timeless: not show'n any dates or often edited rrrambl'n< / li >
< li > interest'n: show a bunch o' interest'n elements like head'ns, code, etc< / li >
< li > balanced: no clutter'n wit' overpresent elements or color'n< / li >
< li > aligned: aligned outlines< / li >
< / ul >
< p > < strong > Used by< / strong > :< / p >
< ul >
2023-10-28 20:28:18 +00:00
< li > Cap'n Hugo Themes info: < a href = "https://themes.gohugo.io/themes/hugo-theme-relearn/" target = "_blank" > https://themes.gohugo.io/themes/hugo-theme-relearn/< / a > < em > 1000 x 1500 @ 1< / em > < / li >
2023-01-24 22:59:44 +00:00
< / ul >
2024-02-24 14:10:30 +00:00
< p > < strong > Plank URL< / strong > : < a href = "/hugo-theme-relearn/pir/shortcodes/notice/index.html" > Screenshot Link< / a > < / p >
2023-01-25 20:34:46 +00:00
< p > < strong > Creat'n< / strong > :< / p >
< ul >
< li > save as < code > images/screenshot.png< / code > < / li >
< / ul >
2023-01-24 22:59:44 +00:00
< p > < strong > Remarks< / strong > :< / p >
< p > Th' locat'n be mandatory due t' Hugo’ s theme ship builder.< / p >
2023-10-11 11:17:41 +00:00
< p > < strong > Preview< / strong > < code > images/screenshot.png< / code > :< / p >
2024-03-16 11:57:28 +00:00
< p > < a href = "#R-image-e5f410b126c2e9e53e7d95820122aed3" 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-e5f410b126c2e9e53e7d95820122aed3" > < 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 >
2023-01-24 22:59:44 +00:00
< h2 id = "hero-image" > Hero Image< / h2 >
< p > < strong > Rrrambl'n< / strong > :< / p >
2024-02-24 14:10:30 +00:00
< p > Show th' < a href = "/hugo-theme-relearn/pir/dev/screenshots/index.html#demo-screenshot" > Demo Screenshot< / a > plank on different devices an' different themes. Composit'n o' th' different device screenshots into a template.< / p >
2023-01-25 20:34:46 +00:00
< p > Th' rrrambl'n should be:< / p >
2023-01-24 22:59:44 +00:00
< ul >
2023-01-25 20:34:46 +00:00
< li > consistent: always use th' same plank fer all devices< / li >
< li > pleas'n: use a delightful background< / li >
2023-01-24 22:59:44 +00:00
< / ul >
< p > < strong > Used by< / strong > :< / p >
< ul >
2023-10-28 20:28:18 +00:00
< li > Cap'n Hugo Themes gallery: < a href = "https://themes.gohugo.io/tags/docs/" target = "_blank" > https://themes.gohugo.io/tags/docs/< / a > < em > 900 x 600< / em > < / li >
< li > Cap'n Hugo Themes notes: < a href = "https://themes.gohugo.io/themes/hugo-theme-relearn/" target = "_blank" > https://themes.gohugo.io/themes/hugo-theme-relearn/< / a > < em > 1280 x 640< / em > < / li >
< li > GitHub project ship: < a href = "https://github.com/McShelby/hugo-theme-relearn" target = "_blank" > 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" target = "_blank" > https://github.com/McShelby/hugo-theme-relearn/sett'ns< / a > < em > 1280 x 640< / em > < / li >
2023-01-24 22:59:44 +00:00
< / ul >
2024-02-24 14:10:30 +00:00
< p > < strong > Plank URL< / strong > : < a href = "/hugo-theme-relearn/pir/shortcodes/notice/index.html" > Hero Image Link< / a > < / p >
2023-01-24 22:59:44 +00:00
< p > < strong > Creat'n< / strong > :< / p >
< ul >
2023-10-28 20:28:18 +00:00
< li > Template: < a href = "http://www.pixeden.com/psd-web-elements/psd-screen-web-showcase" target = "_blank" > 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 >
2023-01-24 23:27:53 +00:00
< li > From original template size resize t' < em > 2700 x 1800< / em > centered, scale t' < em > 900 x 600< / em > an' save as < code > images/tn.png< / code > < / li >
< li > From original template size resize t' < em > 3000 x 1500< / em > offset y: < em > -330< / em > , scale t' < em > 1280 x 640< / em > an' save as < code > images/hero.png< / code > < / li >
2023-01-24 22:59:44 +00:00
< / ul >
2023-01-25 20:34:46 +00:00
< p > < strong > Remarks< / strong > :< / p >
< p > Th' locat'n o' < code > images/tn.png< / code > be mandatory due t' Hugo’ s theme ship builder.< / p >
2023-10-11 11:17:41 +00:00
< p > < strong > Preview< / strong > < code > images/hero.png< / code > :< / p >
2024-03-16 11:57:28 +00:00
< p > < a href = "#R-image-ec44e3e62eff7e9915702aecfde436a5" 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-ec44e3e62eff7e9915702aecfde436a5" > < 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-10-11 11:17:41 +00:00
< p > < strong > Preview< / strong > < code > images/tn.png< / code > :< / p >
2024-03-16 11:57:28 +00:00
< p > < a href = "#R-image-c983c9d851929d6e65a8697c88deb3a9" 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-c983c9d851929d6e65a8697c88deb3a9" > < 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
< footer class = "footline" >
< / footer >
< / article >
2023-05-17 22:13:41 +00:00
< / section >
< / div >
2023-01-24 22:59:44 +00:00
< / main >
< / div >
2024-03-16 11:57:28 +00:00
< script src = "/hugo-theme-relearn/js/clipboard.min.js?1710590244" defer > < / script >
< script src = "/hugo-theme-relearn/js/perfect-scrollbar.min.js?1710590244" defer > < / script >
< script src = "/hugo-theme-relearn/js/theme.js?1710590244" defer > < / script >
2023-01-24 22:59:44 +00:00
< / body >
< / html >
