mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-23 15:57:57 +00:00
532 lines
32 KiB
HTML
532 lines
32 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="art-x-pir" dir="rtl" itemscope itemtype="http://schema.org/Article">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0">
|
|
<meta name="generator" content="Hugo 0.134.2">
|
|
<meta name="generator" content="Relearn 6.4.0+tip">
|
|
<meta name="robots" content="noindex, nofollow, noarchive, noimageindex">
|
|
<meta name="description" content="This chapter contains informat'n only needed fer development an' maintain'n th' theme.">
|
|
<meta name="author" content="Sören Weber">
|
|
<meta name="twitter:card" content="summary_large_image">
|
|
<meta name="twitter:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
|
|
<meta name="twitter:title" content="Development :: Cap'n Hugo Relearrrn Theme">
|
|
<meta name="twitter:description" content="This chapter contains informat'n only needed fer development an' maintain'n th' theme.">
|
|
<meta property="og:url" content="https://mcshelby.github.io/hugo-theme-relearn/pir/dev/index.html">
|
|
<meta property="og:site_name" content="Cap'n Hugo Relearrrn Theme">
|
|
<meta property="og:title" content="Development :: Cap'n Hugo Relearrrn Theme">
|
|
<meta property="og:description" content="This chapter contains informat'n only needed fer development an' maintain'n th' theme.">
|
|
<meta property="og:locale" content="art_x_pir">
|
|
<meta property="og:type" content="website">
|
|
<meta property="og:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
|
|
<meta itemprop="name" content="Development :: Cap'n Hugo Relearrrn Theme">
|
|
<meta itemprop="description" content="This chapter contains informat'n only needed fer development an' maintain'n th' theme.">
|
|
<meta itemprop="wordCount" content="32">
|
|
<meta itemprop="image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
|
|
<title>Development :: Cap'n Hugo Relearrrn Theme</title>
|
|
<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-x-pir">
|
|
<link href="/hugo-theme-relearn/images/logo.svg?1726172282" rel="icon" type="image/svg+xml">
|
|
<link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1726172282" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1726172282" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/nucleus.css?1726172282" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/auto-complete.css?1726172282" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/auto-complete.css?1726172282" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/perfect-scrollbar.min.css?1726172282" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/fonts.css?1726172282" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fonts.css?1726172282" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/theme.css?1726172282" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/theme-relearn-auto.css?1726172282" rel="stylesheet" id="R-variant-style">
|
|
<link href="/hugo-theme-relearn/css/chroma-relearn-auto.css?1726172282" rel="stylesheet" id="R-variant-chroma-style">
|
|
<link href="/hugo-theme-relearn/css/variant.css?1726172282" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/print.css?1726172282" rel="stylesheet" media="print">
|
|
<link href="/hugo-theme-relearn/css/format-print.css?1726172282" rel="stylesheet">
|
|
<script src="/hugo-theme-relearn/js/variant.js?1726172282"></script>
|
|
<script>
|
|
window.relearn = window.relearn || {};
|
|
window.relearn.relBasePath='..\/..';
|
|
window.relearn.relBaseUri='..\/..\/..';
|
|
window.relearn.absBaseUri='https:\/\/mcshelby.github.io\/hugo-theme-relearn';
|
|
window.relearn.disableAnchorCopy=false;
|
|
window.relearn.disableAnchorScrolling=false;
|
|
window.index_js_url="/hugo-theme-relearn/pir/index.search.js?1726172282";
|
|
// variant stuff
|
|
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' ] );
|
|
// 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}"`;
|
|
</script>
|
|
<style>
|
|
#R-body img.bg-white {
|
|
background-color: white;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body class="mobile-support print disableInlineCopyToClipboard" data-url="/hugo-theme-relearn/pir/dev/index.html">
|
|
<div id="R-body" class="default-animation">
|
|
<div id="R-body-overlay"></div>
|
|
<nav id="R-topbar">
|
|
<div class="topbar-wrapper">
|
|
<div class="topbar-sidebar-divider"></div>
|
|
<div class="topbar-area topbar-area-start" data-area="start">
|
|
<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>
|
|
</div>
|
|
</div>
|
|
<ol class="topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype="http://schema.org/BreadcrumbList"><li
|
|
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Development</span><meta itemprop="position" content="1"></li>
|
|
</ol>
|
|
<div class="topbar-area topbar-area-end" data-area="end">
|
|
<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/pir/shortcodes/tabs/index.html" title="Tabs (🡒)"><i class="fa-fw fas fa-chevron-left"></i></a>
|
|
</div>
|
|
<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/pir/dev/contributing/index.html" title="Contributing (🡐)"><i class="fa-fw fas fa-chevron-right"></i></a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
<div id="R-main-overlay"></div>
|
|
<main id="R-body-inner" class="highlightable chapter narrow" tabindex="-1">
|
|
<div class="flex-block-wrapper">
|
|
<article class="chapter">
|
|
<header class="headline">
|
|
</header>
|
|
<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>
|
|
<div class="children children-h2 children-sort-">
|
|
<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>
|
|
</div>
|
|
|
|
|
|
<footer class="footline">
|
|
</footer>
|
|
</article>
|
|
|
|
<section>
|
|
<h1 class="a11y-only">Subsct'ns o' Development</h1>
|
|
<article class="default">
|
|
<header class="headline">
|
|
</header>
|
|
|
|
<h1 id="contributing">Contributing</h1>
|
|
|
|
<h2 id="code-quality">Code Quality</h2>
|
|
<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" rel="external" target="_self">GitHub project</a> without further acknowledgment. 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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<h2 id="conventional-commits">Conventional Commits</h2>
|
|
<p>Write commit messages 'n th' <a href="https://www.conventionalcommits.org/en/v1.0.0/" rel="external" target="_self">conventional commit</a> format.</p>
|
|
<p>Follow'n be an inpomplete list o' some o' th' used conventional commit types. Be creative.</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th style="text-align: left">Common</th>
|
|
<th style="text-align: left">Feature</th>
|
|
<th style="text-align: left">Structure</th>
|
|
<th style="text-align: left">Shorrrtcodes</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="text-align: left">build</td>
|
|
<td style="text-align: left">a11y</td>
|
|
<td style="text-align: left">favicon</td>
|
|
<td style="text-align: left">attachments</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left">browser</td>
|
|
<td style="text-align: left">archetypes</td>
|
|
<td style="text-align: left">search</td>
|
|
<td style="text-align: left">badge</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left">chore</td>
|
|
<td style="text-align: left">alias</td>
|
|
<td style="text-align: left">menu</td>
|
|
<td style="text-align: left">button</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left">docs</td>
|
|
<td style="text-align: left">generator</td>
|
|
<td style="text-align: left">history</td>
|
|
<td style="text-align: left">children</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left">shorrrtcodes</td>
|
|
<td style="text-align: left">i18n</td>
|
|
<td style="text-align: left">scrollbar</td>
|
|
<td style="text-align: left">expand</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left">theme</td>
|
|
<td style="text-align: left">mobile</td>
|
|
<td style="text-align: left">nav</td>
|
|
<td style="text-align: left">ay'con</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left">print</td>
|
|
<td style="text-align: left">toc</td>
|
|
<td style="text-align: left">include</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left">rss</td>
|
|
<td style="text-align: left">clipboard</td>
|
|
<td style="text-align: left">math</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left">variant</td>
|
|
<td style="text-align: left">syntaxhighlight</td>
|
|
<td style="text-align: left">mermaid</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left">boxes</td>
|
|
<td style="text-align: left">notice</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left">openapi</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left">piratify</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left">siteparam</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left">tabs</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<footer class="footline">
|
|
</footer>
|
|
</article>
|
|
|
|
<article class="default">
|
|
<header class="headline">
|
|
</header>
|
|
|
|
<h1 id="maintaining">Maintaining</h1>
|
|
|
|
<h2 id="semver">Semver</h2>
|
|
<p>This project tries t' follow th' <a href="https://semver.org/" rel="external" target="_self">semver policy</a> - although not followed 100% 'n th' past.</p>
|
|
<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>
|
|
<p>Releases result'n 'n a new major or minor number be called main release.</p>
|
|
<p>Releases contain'n bugfixes 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>
|
|
<h2 id="managing-issues">Manag'n Issues</h2>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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 style="text-align: left">Label</th>
|
|
<th style="text-align: left">Descript'n</th>
|
|
<th style="text-align: left">Changelog section</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #5498d8;">documentat'n</span></span></td>
|
|
<td style="text-align: left">Improvements or addit'ns t' documentat'n</td>
|
|
<td style="text-align: left">-</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #99d856;">discussion</span></span></td>
|
|
<td style="text-align: left">This issue was converted t' a discussion</td>
|
|
<td style="text-align: left">-</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #d8d104;">task</span></span></td>
|
|
<td style="text-align: left">Maintenance work</td>
|
|
<td style="text-align: left">Maintenance</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #d8ae04;">feature</span></span></td>
|
|
<td style="text-align: left">New feature or request</td>
|
|
<td style="text-align: left">Features</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #d88704;">bug</span></span></td>
|
|
<td style="text-align: left">Someth'n isn’t work'n</td>
|
|
<td style="text-align: left">Fixes</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="impact">Impact</h3>
|
|
<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>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th style="text-align: left">Label</th>
|
|
<th style="text-align: left">Descript'n</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #d73a4a;">change</span></span></td>
|
|
<td style="text-align: left">Introduces changes wit' exist'n installat'ns</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #d73a4a;">break'n</span></span></td>
|
|
<td style="text-align: left">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 style="text-align: left">Label</th>
|
|
<th style="text-align: left">Descript'n</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #9fa2a5;">duplicate</span></span></td>
|
|
<td style="text-align: left">This issue or pull request already exists</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #9fa2a5;">invalid</span></span></td>
|
|
<td style="text-align: left">This doesn’t seem right</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #9fa2a5;">support</span></span></td>
|
|
<td style="text-align: left">Request fer achiev'n a special goal</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #9fa2a5;">unresolved</span></span></td>
|
|
<td style="text-align: left">No progress on this issue</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #9fa2a5;">update</span></span></td>
|
|
<td style="text-align: left">A change 'n behavior after updat</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #9fa2a5;">wontchange</span></span></td>
|
|
<td style="text-align: left">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 style="text-align: left">Label</th>
|
|
<th style="text-align: left">Descript'n</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #998f6b;">blocked</span></span></td>
|
|
<td style="text-align: left">Depends on other issue t' be fixed first</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #998f6b;">idea</span></span></td>
|
|
<td style="text-align: left">A valu'ble idea that’s currently not worked on</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #998f6b;">undecided</span></span></td>
|
|
<td style="text-align: left">No decision was made yet</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #6426ff;">helpwanted</span></span></td>
|
|
<td style="text-align: left">Great idea, send 'n a PR</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #6426ff;">needsfeedback</span></span></td>
|
|
<td style="text-align: left">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 style="text-align: left">Label</th>
|
|
<th style="text-align: left">Descript'n</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #e550a7;">asciidoc</span></span></td>
|
|
<td style="text-align: left">This be a topic related t' process'n o' AsciiDoc</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #e550a7;">browser</span></span></td>
|
|
<td style="text-align: left">This be a topic related t' th' browser but not th' theme</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #e550a7;">device</span></span></td>
|
|
<td style="text-align: left">This be a topic related t' a certain device</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #e550a7;">hugo</span></span></td>
|
|
<td style="text-align: left">This be a topic related t' Cap'n Hugo itself but not th' theme</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #e550a7;">mermaid</span></span></td>
|
|
<td style="text-align: left">This be a topic related t' Merrrmaid itself but not th' theme</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="making-releases">Mak'n Releases</h2>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
</ul>
|
|
<p>Aft a successful run o' th' act'n</p>
|
|
<ul>
|
|
<li>th' <a href="https://mcshelby.github.io/hugo-theme-relearn/basics/history/index.html" rel="external" target="_self">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" rel="external" target="_self">What’s new</a> plank be updated, includ'n release version, release date an' text</li>
|
|
<li>th' version number fer th' <code><meta generator></code> be updated</li>
|
|
<li>th' updated files be committed</li>
|
|
<li>th' milestone be closed</li>
|
|
<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>
|
|
<li>a new entry 'n th' <a href="https://github.com/McShelby/hugo-theme-relearn/releases" rel="external" target="_self">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" rel="external" target="_self">official documentat'n</a> be built an' deployed</li>
|
|
<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>
|
|
<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">
|
|
<header class="headline">
|
|
</header>
|
|
|
|
<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>
|
|
<p><strong>Creat'n</strong>:</p>
|
|
<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>
|
|
<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>
|
|
</ul>
|
|
<h2 id="demo-screenshot">Demo Screenshot</h2>
|
|
<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>
|
|
<li>Cap'n 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>Cap'n 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>
|
|
</ul>
|
|
<p><strong>Plank URL</strong>: <a href="/hugo-theme-relearn/pir/shortcodes/notice/index.html">Screenshot Link</a></p>
|
|
<p><strong>Creat'n</strong>:</p>
|
|
<ul>
|
|
<li>save as <code>images/screenshot.png</code></li>
|
|
<li>from original screenshot, scale t' <em>900 x 600</em> an' save as <code>images/tn.png</code></li>
|
|
</ul>
|
|
<p><strong>Remarks</strong>:</p>
|
|
<p>Th' locat'ns be mandatory due t' Hugo’s theme ship builder.</p>
|
|
<p><strong>Preview</strong> <code>images/screenshot.png</code>:</p>
|
|
<p><a href="#R-image-c0c74ab22c0531891418182874e946af" 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-c0c74ab22c0531891418182874e946af"><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>
|
|
<p><strong>Preview</strong> <code>images/tn.png</code>:</p>
|
|
<p><a href="#R-image-4ae41b219627e81dfeb438fad5018431" 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-4ae41b219627e81dfeb438fad5018431"><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>
|
|
<h2 id="hero-image">Hero Image</h2>
|
|
<p><strong>Rrrambl'n</strong>:</p>
|
|
<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>
|
|
<p>Th' rrrambl'n should be:</p>
|
|
<ul>
|
|
<li>consistent: always use th' same plank fer all devices</li>
|
|
<li>pleas'n: use a delightful background</li>
|
|
</ul>
|
|
<p><strong>Used by</strong>:</p>
|
|
<ul>
|
|
<li>Cap'n 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 ship: <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/sett'ns</a> <em>1280 x 640</em></li>
|
|
</ul>
|
|
<p><strong>Plank URL</strong>: <a href="/hugo-theme-relearn/pir/shortcodes/notice/index.html">Hero Image Link</a></p>
|
|
<p><strong>Creat'n</strong>:</p>
|
|
<ul>
|
|
<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>
|
|
<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>
|
|
<li>From original template 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>
|
|
</ul>
|
|
<p><strong>Preview</strong> <code>images/hero.png</code>:</p>
|
|
<p><a href="#R-image-fc41fa2f82f1610fea5277e26f1020f3" 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-fc41fa2f82f1610fea5277e26f1020f3"><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>
|
|
|
|
|
|
<footer class="footline">
|
|
</footer>
|
|
</article>
|
|
|
|
</section>
|
|
</div>
|
|
</main>
|
|
</div>
|
|
<script src="/hugo-theme-relearn/js/clipboard.min.js?1726172282" defer></script>
|
|
<script src="/hugo-theme-relearn/js/perfect-scrollbar.min.js?1726172282" defer></script>
|
|
<script src="/hugo-theme-relearn/js/theme.js?1726172282" defer></script>
|
|
</body>
|
|
</html>
|