nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-10-27 18:53:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
hugo-theme-relearn/pir/dev/index.print.html

526 lines
25 KiB
HTML
Raw Normal View History

deploy: 1662d4a95b1d917157c0130405324060d26b4752
2023-01-24 22:59:44 +00:00
<!DOCTYPE html>
deploy: ba09924026e49865b86676f7c4202f142fce9a8c
2023-02-08 21:24:18 +00:00
<html lang="pir" dir="rtl">
deploy: 1662d4a95b1d917157c0130405324060d26b4752
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">
deploy: 4416ab4c7c4e40ef3edc4faf442c5658510986e1
2023-09-26 19:28:12 +00:00
<meta name="generator" content="Hugo 0.119.0">
deploy: e6da7becae37139d8bc70f8ef59d4670fd0b5140
2023-09-26 20:54:39 +00:00
<meta name="generator" content="Relearn 5.22.0+tip">
deploy: 1662d4a95b1d917157c0130405324060d26b4752
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">
<meta name="author" content="Sören Weber">
<title>Development :: Cap&#39;n Hugo Relearrrn Theme</title>
deploy: 8882e2eff3264babdbe43639b2c2b496397fb56e
2023-01-25 11:42:06 +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="pir">
deploy: 977e4c5ab2f467fc7e933aa9963e4d7304a20913
2023-10-02 08:38:19 +00:00
<link href="../../images/logo.svg?1696235893" rel="icon" type="image/svg+xml">
deploy: 1662d4a95b1d917157c0130405324060d26b4752
2023-01-24 22:59:44 +00:00
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
deploy: 977e4c5ab2f467fc7e933aa9963e4d7304a20913
2023-10-02 08:38:19 +00:00
<link href="../../css/fontawesome-all.min.css?1696235895" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fontawesome-all.min.css?1696235895" rel="stylesheet"></noscript>
<link href="../../css/nucleus.css?1696235895" rel="stylesheet">
<link href="../../css/auto-complete.css?1696235895" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/auto-complete.css?1696235895" rel="stylesheet"></noscript>
<link href="../../css/perfect-scrollbar.min.css?1696235895" rel="stylesheet">
<link href="../../css/fonts.css?1696235895" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fonts.css?1696235895" rel="stylesheet"></noscript>
<link href="../../css/theme.css?1696235895" rel="stylesheet">
<link href="../../css/theme-auto.css?1696235895" rel="stylesheet" id="R-variant-style">
<link href="../../css/variant.css?1696235895" rel="stylesheet">
<link href="../../css/print.css?1696235895" rel="stylesheet" media="print">
<link href="../../css/format-print.css?1696235895" rel="stylesheet">
<link href="../../css/ie.css?1696235895" rel="stylesheet">
<script src="../../js/url.js?1696235895"></script>
<script src="../../js/variant.js?1696235895"></script>
deploy: 1662d4a95b1d917157c0130405324060d26b4752
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
window.index_js_url="../../pir/index.search.js";
var root_url="../../";
var baseUri=root_url.replace(/\/$/, '');
// translations
window.T_Copy_to_clipboard = 'Copy t\u0027 clipboard';
window.T_Copied_to_clipboard = 'Copied t\u0027 clipboard!';
window.T_Copy_link_to_clipboard = 'Copy link t\u0027 clipboard';
window.T_Link_copied_to_clipboard = 'Copied link t\u0027 clipboard!';
deploy: 451cd0d4db651237de9846d9ca9d157093248669
2023-09-26 20:26:46 +00:00
window.T_Reset_view = 'Rrreset view';
deploy: 95385935304f6d3c15e9a4ab60e4b9b6ac78c587
2023-10-01 10:25:48 +00:00
window.T_View_reset = 'View rrreset!';
deploy: 1662d4a95b1d917157c0130405324060d26b4752
2023-01-24 22:59:44 +00:00
window.T_No_results_found = 'No rrresults found fer \u0022{0}\u0022';
window.T_N_results_found = '{1} rrresults found fer \u0022{0}\u0022';
// some further base stuff
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
deploy: 3dce59264ef4952899f81a9c5c8bf983cb9dbd5f
2023-08-12 14:11:21 +00:00
window.variants && variants.init( [ 'auto', 'relearn-bright', 'relearn-light', 'relearn-dark', 'zen-light', 'zen-dark', 'neon', 'learn', 'blue', 'green', 'red' ] );
deploy: 1662d4a95b1d917157c0130405324060d26b4752
2023-01-24 22:59:44 +00:00
</script>
<style>
deploy: e18c213e8c74aaba3e58c309d86ac7b4eccbd56d
2023-09-23 08:19:35 +00:00
#R-body img.bg-white {
deploy: 1662d4a95b1d917157c0130405324060d26b4752
2023-01-24 22:59:44 +00:00
background-color: white;
}
</style>
</head>
<body class="mobile-support print disableInlineCopyToClipboard" data-url="../../pir/dev/index.html">
deploy: e18c213e8c74aaba3e58c309d86ac7b4eccbd56d
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">
deploy: e0652394980a7f53c9fa7850b24a770473c65358
2023-09-18 18:49:44 +00:00
<div class="topbar-wrapper">
deploy: 4921ec0583e9a60e1baa53e9764473fefdd6f7e3
2023-09-13 21:30:04 +00:00
<div class="topbar-sidebar-divider"></div>
deploy: e0652394980a7f53c9fa7850b24a770473c65358
2023-09-18 18:49:44 +00:00
<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&#43;ALT&#43;n)">
deploy: 626841a16c04a62cf89132c78f776c03734996f8
2023-09-12 21:10:21 +00:00
<i class="fa-fw fas fa-bars"></i>
</button>
</div>
deploy: 4921ec0583e9a60e1baa53e9764473fefdd6f7e3
2023-09-13 21:30:04 +00:00
</div>
deploy: bb68b7b28a9c2e58dc1d04f43d275b441355ffae
2023-09-20 22:28:27 +00:00
<ol class="topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype="http://schema.org/BreadcrumbList"><li
deploy: 7622913ac25fd6e5ff391b558d57ecc10fb32ab0
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>
deploy: 4921ec0583e9a60e1baa53e9764473fefdd6f7e3
2023-09-13 21:30:04 +00:00
</ol>
deploy: e0652394980a7f53c9fa7850b24a770473c65358
2023-09-18 18:49:44 +00:00
<div class="topbar-area topbar-area-end" data-area="end">
deploy: 5d89ffcfd0e78fe128f882245c2889eb13ec77a5
2023-09-12 21:19:47 +00:00
</div>
deploy: 1662d4a95b1d917157c0130405324060d26b4752
2023-01-24 22:59:44 +00:00
</div>
</nav>
deploy: e18c213e8c74aaba3e58c309d86ac7b4eccbd56d
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">
deploy: 1662d4a95b1d917157c0130405324060d26b4752
2023-01-24 22:59:44 +00:00
<div class="flex-block-wrapper">
<article class="chapter">
deploy: da634d62c8ad5ff17885b2370ebd79b4ef4279fc
2023-05-19 18:46:07 +00:00
<header class="headline">
</header>
deploy: 1662d4a95b1d917157c0130405324060d26b4752
2023-01-24 22:59:44 +00:00
<div class="article-subheading">T&#39; chapterrr 4</div>
<h1 id="development">Development</h1>
<p>This chapter contains informat'n only needed fer development an' maintain'n th' theme.</p>
deploy: ea59244858e2b2f60e583cfecdb1e2c60154f1e4
2023-06-03 20:59:23 +00:00
deploy: 1662d4a95b1d917157c0130405324060d26b4752
2023-01-24 22:59:44 +00:00
<div class="children children-h2 children-sort-">
deploy: ea59244858e2b2f60e583cfecdb1e2c60154f1e4
2023-06-03 20:59:23 +00:00
deploy: f183d83e1500da02bdcf880f171b75026becbdfa
2023-01-28 13:49:11 +00:00
<h2><a href="../../dev/contributing/index.html">Contribut'n</a></h2><p>What t' know if ye want t' contribute</p>
deploy: 551dbfe17ee2ec298a2cb07b1f76b9e9fd451e0e
2023-01-29 10:31:41 +00:00
<h2><a href="../../dev/maintaining/index.html">Maintain'n</a></h2><p>What t' know as a maintainer</p>
deploy: 1662d4a95b1d917157c0130405324060d26b4752
2023-01-24 22:59:44 +00:00
<h2><a href="../../dev/screenshots/index.html">Screenshots</a></h2><p>Recipe t' create various documentat'n screenshots</p>
</div>
<footer class="footline">
deploy: c25bc2a27ab46649393ef7b310e14fff1311116d
2023-05-26 06:40:21 +00:00
deploy: 1662d4a95b1d917157c0130405324060d26b4752
2023-01-24 22:59:44 +00:00
</footer>
</article>
<section>
<h1 class="a11y-only">Subsct&#39;ns o&#39; Development</h1>
<article class="default">
deploy: da634d62c8ad5ff17885b2370ebd79b4ef4279fc
2023-05-19 18:46:07 +00:00
<header class="headline">
</header>
deploy: f183d83e1500da02bdcf880f171b75026becbdfa
2023-01-28 13:49:11 +00:00
<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" 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>
<p>Stay simple fer th' user by focus'n on th' mantra &ldquo;convent'n over configuration&rdquo;.</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&rsquo;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="../../basics/migration/">What&rsquo;s new</a> plank.</p>
<p>Don&rsquo;t break exist'n features if ye don&rsquo;t have t'.</p>
<p>Remove reported issue from th' browser&rsquo;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&rsquo;t use JavaScript arrow funct'ns</li>
<li>don&rsquo;t use JavaScript template literals</li>
<li>don&rsquo;t use other fancy JavaScript ES5/6 stuff</li>
</ul>
<h2 id="conventional-commits">Conventional Commits</h2>
<p>Write commit messages 'n th' <a href="https://www.conventionalcommits.org/en/v1.0.0/" target="_blank">conventional commit</a> format.</p>
<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>
deploy: 06d35bbbdb000f9f89780c78310385c68afb6925
2023-05-14 21:06:26 +00:00
<td>openapi</td>
deploy: f183d83e1500da02bdcf880f171b75026becbdfa
2023-01-28 13:49:11 +00:00
</tr>
<tr>
<td></td>
<td></td>
<td></td>
deploy: 06d35bbbdb000f9f89780c78310385c68afb6925
2023-05-14 21:06:26 +00:00
<td>piratify</td>
deploy: f183d83e1500da02bdcf880f171b75026becbdfa
2023-01-28 13:49:11 +00:00
</tr>
<tr>
<td></td>
<td></td>
<td></td>
deploy: 06d35bbbdb000f9f89780c78310385c68afb6925
2023-05-14 21:06:26 +00:00
<td>siteparam</td>
deploy: f183d83e1500da02bdcf880f171b75026becbdfa
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">
deploy: c25bc2a27ab46649393ef7b310e14fff1311116d
2023-05-26 06:40:21 +00:00
deploy: f183d83e1500da02bdcf880f171b75026becbdfa
2023-01-28 13:49:11 +00:00
</footer>
</article>
<article class="default">
deploy: da634d62c8ad5ff17885b2370ebd79b4ef4279fc
2023-05-19 18:46:07 +00:00
<header class="headline">
</header>
deploy: 551dbfe17ee2ec298a2cb07b1f76b9e9fd451e0e
2023-01-29 10:31:41 +00:00
<h1 id="maintaining">Maintaining</h1>
deploy: f183d83e1500da02bdcf880f171b75026becbdfa
2023-01-28 13:49:11 +00:00
<h2 id="semver">Semver</h2>
<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>
<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="../../basics/migration/">What&rsquo;s new</a> plank causes a new major release number.</p>
<p>All other entries on th' <a href="../../basics/migration/">What&rsquo;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 bugixes only, be only increas'n th' patch release number. Those releases don&rsquo;t result 'n announcements on th' <a href="../../basics/migration/">What&rsquo;s new</a> plank.</p>
<p>Entries on th' <a href="../../basics/migration/">What&rsquo;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="#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>
deploy: 64c2f177f129ad3f63d4499e391f09247bf9c6d5
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>
deploy: f183d83e1500da02bdcf880f171b75026becbdfa
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>
<td>Maintainence work</td>
<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&rsquo;t work'n</td>
<td>Fixes</td>
</tr>
</tbody>
</table>
<h3 id="impact">Impact</h3>
<p>If th' issue would cause a new main release due t' <a href="#semver">semver semantics</a> it needs one o' th' accord'n labels an' th' match'n badge on th' <a href="../../basics/migration/">What&rsquo;s new</a> plank.</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: #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&rsquo;t seem right</td>
</tr>
<tr>
<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>
deploy: 686c013ef5fbaeaa9089a1f89c60079560a29d12
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>
deploy: f183d83e1500da02bdcf880f171b75026becbdfa
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&rsquo;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>
<td>No decission was made yet</td>
</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>
deploy: 22b18a42325ce262327928207b769901a94e9544
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>
deploy: f183d83e1500da02bdcf880f171b75026becbdfa
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>
<p>A release be based on a milestone named like th' release itself - just th' version number, eg: <code>1.2.3</code>. It&rsquo;s 'n th' maintainers responsiblity t' check <a href="#semver">semver semantics</a> o' th' milestone&rsquo;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>
deploy: 64c2f177f129ad3f63d4499e391f09247bf9c6d5
2023-01-30 15:55:08 +00:00
<p>Treat released milestones as immut'ble. Don&rsquo;t rerelease an already released milestone. An already released milestone may already been consumed by yer users.</p>
deploy: f183d83e1500da02bdcf880f171b75026becbdfa
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>
<li>if it&rsquo;s a main release, there must be a new <code>&lt;major&gt;.&lt;minor&gt;</code> at th' beginn'n o' th' <a href="../../basics/migration/">What&rsquo;s new</a> plank</li>
<li>if it&rsquo;s a patch release, there must be th' <code>&lt;major&gt;.&lt;minor&gt;</code> from th' previous release at th' beginn'n o' th' <a href="../../basics/migration/">What&rsquo;s new</a> plank</li>
</ul>
<p>Aft a successful run o' th' act'n</p>
<ul>
deploy: 43c98ccc24ef0554a6e1a3a55d5ce0fd34870a60
2023-01-29 10:28:20 +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&rsquo;s new</a> plank be updated, includ'n release version, release date an' text</li>
deploy: f183d83e1500da02bdcf880f171b75026becbdfa
2023-01-28 13:49:11 +00:00
<li>th' version number fer th' <code>&lt;meta generator&gt;</code> be updated</li>
<li>th' updated files be commited</li>
<li>th' milestone be closed</li>
deploy: 41e3d96a64887e32cd4810c89b8a15645a6b230f
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>
deploy: f183d83e1500da02bdcf880f171b75026becbdfa
2023-01-28 13:49:11 +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>
<li>th' version number fer th' <code>&lt;meta generator&gt;</code> be updated t' a temporary an' commited (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">
deploy: c25bc2a27ab46649393ef7b310e14fff1311116d
2023-05-26 06:40:21 +00:00
deploy: f183d83e1500da02bdcf880f171b75026becbdfa
2023-01-28 13:49:11 +00:00
</footer>
</article>
<article class="default">
deploy: da634d62c8ad5ff17885b2370ebd79b4ef4279fc
2023-05-19 18:46:07 +00:00
<header class="headline">
</header>
deploy: 1662d4a95b1d917157c0130405324060d26b4752
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>
deploy: df66b6fadeeda9fa31f4aff5f411eb5e164ebf5c
2023-01-28 10:59:37 +00:00
<p><strong>Creat'n</strong>:</p>
deploy: 1662d4a95b1d917157c0130405324060d26b4752
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>
deploy: df66b6fadeeda9fa31f4aff5f411eb5e164ebf5c
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>
deploy: 1662d4a95b1d917157c0130405324060d26b4752
2023-01-24 22:59:44 +00:00
</ul>
deploy: df66b6fadeeda9fa31f4aff5f411eb5e164ebf5c
2023-01-28 10:59:37 +00:00
<h2 id="demo-screenshot">Demo Screenshot</h2>
deploy: 1662d4a95b1d917157c0130405324060d26b4752
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>
<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>
</ul>
<p><strong>Plank URL</strong>: <a href="../../shortcodes/include/">Screenshot Link</a></p>
deploy: 8f141fc0d5b590cce58b83bdbd437d354193bf2f
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>
deploy: 1662d4a95b1d917157c0130405324060d26b4752
2023-01-24 22:59:44 +00:00
<p><strong>Remarks</strong>:</p>
<p>Th' locat'n be mandatory due t' Hugo&rsquo;s theme ship builder.</p>
deploy: df66b6fadeeda9fa31f4aff5f411eb5e164ebf5c
2023-01-28 10:59:37 +00:00
<h3 id="preview-imagesscreenshotpng">Preview <code>images/screenshot.png</code></h3>
deploy: 977e4c5ab2f467fc7e933aa9963e4d7304a20913
2023-10-02 08:38:19 +00:00
<p><a href="#R-image-4a715f435bfa8974b0f96781004386d6" class="lightbox-link"><img src="../../images/screenshot.png?width=100%25&amp;height=100%25" alt="Screenshot" class="figure-image bg-white border lightbox noshadow" style="height: 100%; width: 100%;" loading="lazy"></a>
<a href="javascript:history.back();" class="lightbox-back" id="R-image-4a715f435bfa8974b0f96781004386d6"><img src="../../images/screenshot.png?width=100%25&amp;height=100%25" alt="Screenshot" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p>
deploy: 1662d4a95b1d917157c0130405324060d26b4752
2023-01-24 22:59:44 +00:00
<h2 id="hero-image">Hero Image</h2>
<p><strong>Rrrambl'n</strong>:</p>
deploy: df66b6fadeeda9fa31f4aff5f411eb5e164ebf5c
2023-01-28 10:59:37 +00:00
<p>Show th' <a href="#demo-screenshot">Demo Screenshot</a> plank on different devices an' different themes. Composit'n o' th' different device screenshots into a template.</p>
deploy: 8f141fc0d5b590cce58b83bdbd437d354193bf2f
2023-01-25 20:34:46 +00:00
<p>Th' rrrambl'n should be:</p>
deploy: 1662d4a95b1d917157c0130405324060d26b4752
2023-01-24 22:59:44 +00:00
<ul>
deploy: 8f141fc0d5b590cce58b83bdbd437d354193bf2f
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>
deploy: 1662d4a95b1d917157c0130405324060d26b4752
2023-01-24 22:59:44 +00:00
</ul>
<p><strong>Used by</strong>:</p>
<ul>
<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>
deploy: eb1aef54ed34f83b5ceff8241a22bfee7d7c61a2
2023-01-24 23:27:53 +00:00
<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>
deploy: 1662d4a95b1d917157c0130405324060d26b4752
2023-01-24 22:59:44 +00:00
<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>
</ul>
deploy: 8f141fc0d5b590cce58b83bdbd437d354193bf2f
2023-01-25 20:34:46 +00:00
<p><strong>Plank URL</strong>: <a href="../../shortcodes/include/">Hero Image Link</a></p>
deploy: 1662d4a95b1d917157c0130405324060d26b4752
2023-01-24 22:59:44 +00:00
<p><strong>Creat'n</strong>:</p>
<ul>
<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>
<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>
deploy: eb1aef54ed34f83b5ceff8241a22bfee7d7c61a2
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>
deploy: 1662d4a95b1d917157c0130405324060d26b4752
2023-01-24 22:59:44 +00:00
</ul>
deploy: 8f141fc0d5b590cce58b83bdbd437d354193bf2f
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&rsquo;s theme ship builder.</p>
deploy: df66b6fadeeda9fa31f4aff5f411eb5e164ebf5c
2023-01-28 10:59:37 +00:00
<h3 id="preview-imagesheropng">Preview <code>images/hero.png</code></h3>
deploy: 977e4c5ab2f467fc7e933aa9963e4d7304a20913
2023-10-02 08:38:19 +00:00
<p><a href="#R-image-cca00a77dae90a7124aa6c73197fd119" class="lightbox-link"><img src="../../images/hero.png?width=100%25&amp;height=100%25" alt="Hero" class="figure-image bg-white border lightbox noshadow" style="height: 100%; width: 100%;" loading="lazy"></a>
<a href="javascript:history.back();" class="lightbox-back" id="R-image-cca00a77dae90a7124aa6c73197fd119"><img src="../../images/hero.png?width=100%25&amp;height=100%25" alt="Hero" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p>
deploy: df66b6fadeeda9fa31f4aff5f411eb5e164ebf5c
2023-01-28 10:59:37 +00:00
<h3 id="preview-imagestnpng">Preview <code>images/tn.png</code></h3>
deploy: 977e4c5ab2f467fc7e933aa9963e4d7304a20913
2023-10-02 08:38:19 +00:00
<p><a href="#R-image-fb2f07d7f942cfac021ef130e7c83df8" class="lightbox-link"><img src="../../images/tn.png?width=100%25&amp;height=100%25" alt="tn" class="figure-image bg-white border lightbox noshadow" style="height: 100%; width: 100%;" loading="lazy"></a>
<a href="javascript:history.back();" class="lightbox-back" id="R-image-fb2f07d7f942cfac021ef130e7c83df8"><img src="../../images/tn.png?width=100%25&amp;height=100%25" alt="tn" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p>
deploy: 1662d4a95b1d917157c0130405324060d26b4752
2023-01-24 22:59:44 +00:00
<footer class="footline">
deploy: c25bc2a27ab46649393ef7b310e14fff1311116d
2023-05-26 06:40:21 +00:00
deploy: 1662d4a95b1d917157c0130405324060d26b4752
2023-01-24 22:59:44 +00:00
</footer>
</article>
deploy: f38878f664f9eec474d624cbb498ea63f95202ac
2023-05-17 22:13:41 +00:00
</section>
</div>
deploy: 1662d4a95b1d917157c0130405324060d26b4752
2023-01-24 22:59:44 +00:00
</main>
</div>
deploy: 977e4c5ab2f467fc7e933aa9963e4d7304a20913
2023-10-02 08:38:19 +00:00
<script src="../../js/clipboard.min.js?1696235896" defer></script>
<script src="../../js/perfect-scrollbar.min.js?1696235896" defer></script>
<script src="../../js/theme.js?1696235896" defer></script>
deploy: 1662d4a95b1d917157c0130405324060d26b4752
2023-01-24 22:59:44 +00:00
</body>
</html>
Reference in a new issue Copy permalink