mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2025-05-06 10:06:36 +00:00
deploy: f183d83e15
This commit is contained in:
McShelby
parent
8cc46c8f8a
commit
c7dc9a6cbd
362 changed files with 11679 additions and 8031 deletions
dev
436
dev/contributing/index.html
Normal file
436
dev/contributing/index.html
Normal file
|
|
@ -0,0 +1,436 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en" dir="ltr">
|
||||
<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.110.0">
|
||||
<meta name="generator" content="Relearn 5.10.2+tip">
|
||||
<meta name="robots" content="noindex, nofollow, noarchive, noimageindex">
|
||||
<meta name="description" content="What to know if you want to contribute">
|
||||
<meta name="author" content="Sören Weber">
|
||||
<title>Contributing :: Hugo Relearn Theme</title>
|
||||
<link href="https://McShelby.github.io/hugo-theme-relearn/dev/contributing/index.html" rel="alternate" hreflang="x-default">
|
||||
<link href="https://McShelby.github.io/hugo-theme-relearn/dev/contributing/index.html" rel="alternate" hreflang="en">
|
||||
<link href="https://McShelby.github.io/hugo-theme-relearn/pir/dev/contributing/index.html" rel="alternate" hreflang="pir">
|
||||
<link href="../../images/logo.svg?1674913744" rel="icon" type="image/svg+xml">
|
||||
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
|
||||
<link href="../../css/fontawesome-all.min.css?1674913744" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fontawesome-all.min.css?1674913744" rel="stylesheet"></noscript>
|
||||
<link href="../../css/featherlight.min.css?1674913744" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/featherlight.min.css?1674913744" rel="stylesheet"></noscript>
|
||||
<link href="../../css/auto-complete.css?1674913744" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/auto-complete.css?1674913744" rel="stylesheet"></noscript>
|
||||
<link href="../../css/perfect-scrollbar.min.css?1674913744" rel="stylesheet">
|
||||
<link href="../../css/nucleus.css?1674913744" rel="stylesheet">
|
||||
<link href="../../css/fonts.css?1674913744" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fonts.css?1674913744" rel="stylesheet"></noscript>
|
||||
<link href="../../css/theme.css?1674913744" rel="stylesheet">
|
||||
<link href="../../css/theme-relearn-light.css?1674913744" rel="stylesheet" id="variant-style">
|
||||
<link href="../../css/ie.css?1674913744" rel="stylesheet">
|
||||
<link href="../../css/variant.css?1674913744" rel="stylesheet">
|
||||
<link href="../../css/print.css?1674913744" rel="stylesheet" media="print">
|
||||
<script src="../../js/url.js?1674913744"></script>
|
||||
<script src="../../js/variant.js?1674913744"></script>
|
||||
<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="../../index.search.js";
|
||||
var root_url="../../";
|
||||
var baseUri=root_url.replace(/\/$/, '');
|
||||
// translations
|
||||
window.T_Copy_to_clipboard = 'Copy to clipboard';
|
||||
window.T_Copied_to_clipboard = 'Copied to clipboard!';
|
||||
window.T_Copy_link_to_clipboard = 'Copy link to clipboard';
|
||||
window.T_Link_copied_to_clipboard = 'Copied link to clipboard!';
|
||||
window.T_No_results_found = 'No results found for \u0022{0}\u0022';
|
||||
window.T_N_results_found = '{1} results found for \u0022{0}\u0022';
|
||||
// some further base stuff
|
||||
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
|
||||
window.variants && variants.init( [ 'relearn-light', 'relearn-dark', 'learn', 'neon', 'blue', 'green', 'red' ] );
|
||||
</script>
|
||||
<script src="../../js/jquery.min.js?1674913744" defer></script>
|
||||
<style>
|
||||
#body img.bg-white {
|
||||
background-color: white;
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body class="mobile-support html disableInlineCopyToClipboard" data-url="../../dev/contributing/index.html">
|
||||
<div id="body" class="default-animation">
|
||||
<div id="sidebar-overlay"></div>
|
||||
<div id="toc-overlay"></div>
|
||||
<nav id="topbar" class="highlightable" dir="ltr">
|
||||
<div>
|
||||
<div class="navigation">
|
||||
<a class="nav nav-next" href="../../dev/maintaining/index.html" title="Issue and Release Management (🡒)"><i class="fas fa-chevron-right fa-fw"></i></a>
|
||||
</div>
|
||||
<div class="navigation">
|
||||
<a class="nav nav-prev" href="../../dev/index.html" title="Development (🡐)"><i class="fas fa-chevron-left fa-fw"></i></a>
|
||||
</div>
|
||||
<div id="top-print-link">
|
||||
<a class="print-link" title='Print whole chapter (CTRL+ALT+p)' href="../../dev/contributing/index.print.html">
|
||||
<i class="fas fa-print fa-fw"></i>
|
||||
</a>
|
||||
</div>
|
||||
<div id="top-github-link">
|
||||
<a class="github-link" title='Edit (CTRL+ALT+w)' href="https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/dev/contributing/_index.en.md" target="_blank">
|
||||
<i class="fas fa-pen fa-fw"></i>
|
||||
</a>
|
||||
</div>
|
||||
<div id="breadcrumbs">
|
||||
<span id="sidebar-toggle-span">
|
||||
<a href="#" id="sidebar-toggle" title='Menu (CTRL+ALT+n)'><i class="fas fa-bars fa-fw"></i></a>
|
||||
</span>
|
||||
<span id="toc-menu" title='Table of Contents (CTRL+ALT+t)'><i class="fas fa-list-alt fa-fw"></i></span>
|
||||
<ol class="links" itemscope itemtype="http://schema.org/BreadcrumbList">
|
||||
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="../../index.html"><span itemprop="name">Hugo Relearn Theme</span></a><meta itemprop="position" content="1"> > </li>
|
||||
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="../../dev/index.html"><span itemprop="name">Development</span></a><meta itemprop="position" content="2"> > </li>
|
||||
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Contributing</span><meta itemprop="position" content="3"></li>
|
||||
</ol>
|
||||
</div>
|
||||
<div class="default-animation progress">
|
||||
<div class="toc-wrapper" dir="ltr">
|
||||
<nav id="TableOfContents">
|
||||
<ul>
|
||||
<li><a href="#code-quality">Code Quality</a></li>
|
||||
<li><a href="#conventional-commits">Conventional Commits</a></li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
<main id="body-inner" class="highlightable default" tabindex="-1">
|
||||
<div class="flex-block-wrapper">
|
||||
<div id="head-tags">
|
||||
</div>
|
||||
<article class="default">
|
||||
<h1 id="contributing">Contributing</h1>
|
||||
|
||||
<h2 id="code-quality">Code Quality</h2>
|
||||
<p>A new release can happen at any time from the <code>main</code> branch of the <a href="https://github.com/McShelby/hugo-theme-relearn" target="_blank">GitHub project</a> without further accknowledgment. This makes it necessary that, every pushed set of changesets into the <code>main</code> branch <strong>must</strong> be self-contained and correct, resulting in a releasable version.</p>
|
||||
<p>Stay simple for the user by focusing on the mantra “convention over configuration”.</p>
|
||||
<p>At installation the site should work reasonable without (m)any configuration.</p>
|
||||
<p>Stay close to the Hugo way.</p>
|
||||
<p>Don’t use npm or any preprocessing, our contributors may not be front-end developers.</p>
|
||||
<p>Document new features in the exampleSite. This also contains entries to the <a href="../../basics/migration/">What’s new</a> page.</p>
|
||||
<p>Don’t break existing features if you don’t have to.</p>
|
||||
<p>Remove reported issue from the browser’s console.</p>
|
||||
<p>Check for unnecessary whitespace and correct indention of your resulting HTML.</p>
|
||||
<p>Be compatible to IE11, at least for main functionality, this means:</p>
|
||||
<ul>
|
||||
<li>test in IE11</li>
|
||||
<li>check caniuse.com</li>
|
||||
<li>don’t use JavaScript arrow functions</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>
|
||||
<p>Write commit messages in the <a href="https://www.conventionalcommits.org/en/v1.0.0/" target="_blank">conventional commit</a> format.</p>
|
||||
<p>Following is an impomplete list of some of the used conventional commit types. Be creative.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Common</th>
|
||||
<th>Feature</th>
|
||||
<th>Structure</th>
|
||||
<th>Shortcodes</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>shortcodes</td>
|
||||
<td>i18n</td>
|
||||
<td>scrollbar</td>
|
||||
<td>expand</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>theme</td>
|
||||
<td>mobile</td>
|
||||
<td>nav</td>
|
||||
<td>icon</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>
|
||||
<td>piratify</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>siteparam</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>swagger</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>tabs</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<footer class="footline">
|
||||
</footer>
|
||||
</article>
|
||||
</div>
|
||||
</main>
|
||||
</div>
|
||||
<aside id="sidebar" class="default-animation showVisitedLinks" dir="ltr">
|
||||
<div id="header-wrapper" class="default-animation">
|
||||
<div id="header" class="default-animation">
|
||||
<style>
|
||||
#logo svg,
|
||||
#logo svg * {
|
||||
color: #282828;
|
||||
color: var(--MENU-SECTIONS-BG-color);
|
||||
fill: #282828 !important;
|
||||
fill: var(--MENU-SECTIONS-BG-color) !important;
|
||||
opacity: .945;
|
||||
}
|
||||
a#logo {
|
||||
color: #282828;
|
||||
color: var(--MENU-SECTIONS-BG-color);
|
||||
font-family: 'Work Sans', 'Helvetica', 'Tahoma', 'Geneva', 'Arial', sans-serif;
|
||||
font-size: 30px;
|
||||
font-weight: 300;
|
||||
margin-top: -13px;
|
||||
max-width: 60%;
|
||||
text-transform: uppercase;
|
||||
width: 226px;
|
||||
white-space: nowrap;
|
||||
}
|
||||
a#logo:hover {
|
||||
color: #282828;
|
||||
color: var(--MENU-SECTIONS-BG-color);
|
||||
}
|
||||
#logo svg {
|
||||
margin-bottom: -20px;
|
||||
margin-left: -23.5px;
|
||||
width: 40.5%;
|
||||
}
|
||||
@media only all and (max-width: 59.938em) {
|
||||
a#logo {
|
||||
font-size: 25px;
|
||||
margin-top: -3px;
|
||||
}
|
||||
#logo svg {
|
||||
margin-bottom: -12px;
|
||||
margin-left: -23px;
|
||||
}
|
||||
}
|
||||
@media all and (-ms-high-contrast:none) {
|
||||
/* IE11s understanding of positioning is weird at best */
|
||||
a#logo {
|
||||
margin-top: -58px;
|
||||
}
|
||||
#logo svg {
|
||||
margin-bottom: -62px;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
<a id="logo" href="../../index.html">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64.044 64.044">
|
||||
<path d="M46.103 136.34c-.642-.394-1.222-2.242-1.98-2.358-.76-.117-1.353.506-1.618 1.519-.266 1.012-.446 4.188.173 5.538.213.435.482.787 1.03.845.547.057.967-.504 1.45-1.027.482-.523.437-.9 1.142-.612.705.289 1.051.4 1.586 1.229.535.828 1.085 4.043.868 5.598-.241 1.458-.531 2.8-.59 4.088.26.075.517.148.772.217 2.68.724 5.373 1.037 7.873.02.001-.028.01-.105.008-.11-.048-.165-.18-.41-.36-.698-.18-.29-.414-.645-.586-1.114a3.212 3.212 0 0 1-.125-1.735c.056-.21.153-.342.249-.475 1.237-1.193 2.932-1.373 4.244-1.384.557-.004 1.389.016 2.198.255.809.239 1.706.724 2.068 1.843.187.578.114 1.17-.043 1.623-.153.438-.369.783-.545 1.091-.178.31-.329.6-.401.821-.007.02-.003.071-.005.094 2.256 1.008 4.716.91 7.189.398.55-.114 1.11-.247 1.673-.377.344-1.085.678-2.145.852-3.208.124-.752.158-2.311-.078-3.538-.118-.613-.306-1.15-.52-1.489-.221-.349-.413-.501-.747-.538-.243-.027-.51.013-.796.098-.67.223-1.33.606-1.966.76l-.008.002-.109.032c-.556.152-1.233.158-1.797-.36-.556-.51-.89-1.367-1.117-2.596-.283-1.528-.075-3.279.89-4.518l.071-.09h.07c.65-.71 1.485-.802 2.16-.599.706.213 1.333.629 1.772.84.736.354 1.185.319 1.475.171.291-.148.5-.439.668-.955.332-1.017.301-2.819.022-4.106-.148-.684-.13-1.292-.13-1.883-1.558-.463-3.067-.982-4.574-1.208-1.128-.169-2.263-.173-3.298.164-.13.046-.256.095-.38.15-.373.164-.633.342-.805.52-.077.098-.081.105-.087.21-.004.068.031.289.13.571.1.282.256.634.467 1.03.279.524.448 1.063.431 1.618a2.12 2.12 0 0 1-.499 1.309 1.757 1.757 0 0 1-.62.51h-.002c-.515.291-1.107.404-1.723.464-.86.083-1.787.026-2.598-.097-.806-.123-1.47-.28-1.948-.555-.444-.256-.79-.547-1.037-.925a2.273 2.273 0 0 1-.356-1.301c.029-.837.403-1.437.625-1.897.111-.23.191-.433.236-.583.045-.15.044-.25.046-.24-.005-.029-.127-.355-1.015-.741-1.138-.495-2.322-.673-3.533-.668h-.015a9.711 9.711 0 0 0-.521.016h-.002c-1.163.057-2.35.308-3.541.569.383 1.531.79 2.753.818 4.502-.096 1.297.158 2.114-1.03 2.935-.85.588-1.508.729-2.15.335" style="fill:#282828;fill-opacity:1;stroke:none;stroke-width:1.03763;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" transform="translate(-40.698 -95.175)"/>
|
||||
<path d="M61.472 101.34v.002c-.3-.003-.603.01-.894.04-.544.055-1.39.165-1.778.306-1.238.364.13 2.344.41 2.913.28.569.285 2.03.14 2.134-.144.103-.375.261-.934.345-.56.084.03-.037-1.589.086-1.62.122-5.506.29-8.265.248-.022.26-.036.521-.097.808-.309 1.442-.63 3.163-.494 4.074.071.473.168.65.414.8.23.14.737.235 1.62-.004.834-.227 1.3-.442 1.887-.456.595-.016 1.555.472 1.965.717.411.245-.03-.008.002 0s.128.05.176.102c.049.053-.276-.523.104.199.379.721.72 3.256.002 4.68-.46.913-1.01 1.49-1.64 1.711-.63.22-1.229.067-1.734-.135-.881-.353-1.584-.7-2.205-.647-1.199 1.94-1.186 4.17-.6 6.602.097.397.212.814.327 1.23 2.68-.556 5.542-1.016 8.337.132 1.064.437 1.73 1.015 1.902 1.857.169.831-.193 1.508-.438 1.986-.122.238-.23.46-.307.642-.07.164-.096.28-.104.324.069.429.309.723.686.945.385.227.89.355 1.35.423.723.104 1.567.152 2.287.086.693-.064 1.032-.338 1.241-.544a2.447 2.447 0 0 0 .303-.437.175.175 0 0 0 .013-.035c-.004-.066-.037-.246-.195-.527-.46-.816-.87-1.595-.817-2.51.028-.476.218-.938.529-1.288.304-.343.698-.586 1.186-.79 1.442-.606 2.96-.609 4.372-.409 1.525.216 2.963.679 4.378 1.083.226-2.09.784-3.9.592-5.77-.058-.565-.287-1.333-.598-1.827-.32-.508-.59-.717-1.036-.642-.648.11-1.472.935-2.707 1.078-.791.092-1.494-.267-1.95-.86-.45-.583-.678-1.335-.78-2.101-.202-1.525.031-3.229.89-4.27.615-.747 1.45-.887 2.15-.74.687.145 1.307.492 1.857.745v-.002c.546.252 1.033.388 1.281.344a.547.547 0 0 0 .353-.188c.113-.124.242-.35.384-.75.604-1.712.206-3.68-.303-5.654-.667.145-1.336.293-2.018.413-1.341.236-2.73.392-4.136.273-.656-.055-1.695-.085-2.58-.476-.442-.195-.903-.514-1.157-1.093-.259-.591-.205-1.313.08-2.014.223-.64 1.082-2.178.692-2.585-.391-.407-1.651-.56-2.554-.571z" style="fill:#282828;fill-opacity:1;stroke:none;stroke-width:.992837;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" transform="translate(-40.698 -95.175)"/>
|
||||
<path d="M83.128 98.116c-.484 1.875-1.057 3.757-2.486 5.033-.638.57-1.13.666-1.483.548-.401-.134-.715-.506-1.058-.973-.338-.461-.655-.97-1.076-1.332-.192-.165-.404-.315-.683-.38-.279-.066-.599-.02-.9.102-.489.196-.89.58-1.28 1.047a6.1 6.1 0 0 0-.985 1.632c-.234.591-.356 1.174-.277 1.713.072.487.392.977.905 1.185.463.187.926.156 1.36.154.433 0 .843.01 1.242.147.55.189.79.736.822 1.368.034.66-.145 1.412-.393 1.988l-.008.021c-.74 1.705-1.946 2.893-3.004 4.349l-.664.915.979.099c.924.092 1.788.26 2.468.675.46.281 1.806 1.205 2.794 2.222.497.513.888 1.031 1.047 1.502.078.231.095.422.05.6a.93.93 0 0 1-.345.474c-.301.223-.606.395-.864.532l-.354.186c-.107.058-.189.087-.345.228a.637.637 0 0 1 .062-.045l-.064.041-.209.236-.103.343s.003.126.007.152c.003.017.003.007.004.015v.002c.016.195.061.307.133.476a4.1 4.1 0 0 0 .32.596 5.7 5.7 0 0 0 2.8 2.258c.284.108.908.321 1.548.36.33.02.59.015.912-.13h.002c.08-.037.228-.095.382-.281.153-.186.19-.355.212-.445l.019-.075.003-.078c.023-.585-.037-1.296.072-1.899.153-.657.435-.956 1.009-.909 2.771.239 4.74 1.955 6.693 3.83l.742.714.279-1.155c.55-2.29 1.093-4.464 2.928-5.977.692-.57 1.184-.642 1.527-.509.39.151.676.536.996.995.319.458.605.926 1.07 1.212.194.119.464.232.784.209.32-.024.638-.163.988-.384 1.022-.645 1.778-1.756 2.086-2.942.136-.522.102-.991-.046-1.301-.158-.334-.433-.553-.754-.707-.653-.314-1.468-.373-2.094-.486-.825-.15-1.22-.475-1.345-.878-.13-.417 0-.953.335-1.61.6-1.173 1.887-2.602 3.13-3.911l.498-.526-.449-.432c-1.545-1.49-3.163-3.01-5.252-3.715h-.002c-.473-.16-1.097-.413-1.73-.424h-.003c-.311-.004-.596.04-.883.24v.002c-.22.155-.483.537-.583.937l-.008.036-.006.038c-.116.773-.06 1.467-.217 1.995-.063.212-.198.418-.359.507-.202.111-.492.153-.976.072-.582-.097-1.978-.69-3.021-1.503-.523-.407-.934-.85-1.117-1.3a1.153 1.153 0 0 1-.083-.63c.03-.184.1-.477.308-.593.21-.116.941-.32 1.377-.642h.002c.192-.141.403-.367.518-.64.114-.275.127-.526.123-.774-.006-.142-.036-.192-.08-.3a8.417 8.417 0 0 0-3-3.027c-1.226-.725-2.585-1.135-3.927-1.539-.434-.12-.844-.111-1.02.466zm.912.947c1.186.364 2.357.718 3.345 1.303 1.035.612 1.864 1.488 2.507 2.528-.514.263-1.095.5-1.44.79-.345.29-.729.914-.815 1.434-.084.509 0 .968.155 1.347.301.74.85 1.276 1.44 1.735 1.18.92 2.554 1.545 3.47 1.698.604.1 1.186.088 1.739-.216.594-.327.935-.911 1.088-1.427.264-.884.193-1.664.262-2.17h.1c.3.006.926.206 1.417.371 1.646.554 3.044 1.773 4.431 3.089-1.102 1.174-2.222 2.423-2.888 3.73-.42.823-.73 1.789-.453 2.687.283.913 1.1 1.415 2.138 1.603.691.126 1.472.226 1.84.403.19.091.258.182.278.223.03.064.058.075-.023.387-.21.804-.761 1.598-1.413 2.01-.247.155-.365.183-.407.187-.042.003-.061.002-.172-.066-.144-.088-.455-.473-.772-.929-.317-.454-.714-1.07-1.452-1.356-.783-.304-1.776-.022-2.713.75-1.942 1.6-2.626 3.764-3.146 5.8-1.802-1.676-3.772-3.138-6.589-3.517h-.002c-.346-.095-1.013-.031-1.293.143-.735.501-1.005 1.132-1.168 2.007-.125.69-.082 1.216-.074 1.659-.055.006-.046.01-.104.006-.42-.026-1.035-.215-1.244-.295-.947-.361-1.774-1.006-2.314-1.857-.054-.085-.072-.132-.109-.2l.027-.016c.284-.15.656-.36 1.045-.648.44-.327.789-.798.93-1.35a2.4 2.4 0 0 0-.068-1.379c-.254-.751-.753-1.353-1.295-1.911-1.09-1.124-2.452-2.049-2.99-2.378-.609-.372-1.303-.44-1.981-.56.875-1.094 1.878-2.251 2.596-3.921.294-.823.543-1.907.513-2.658-.049-.97-.489-2.013-1.52-2.367-.579-.2-1.131-.204-1.58-.203-.45.002-.786-.006-.97-.08h-.002c-.264-.107-.236-.108-.268-.33-.025-.17.021-.553.183-.962a4.67 4.67 0 0 1 .725-1.192c.29-.348.617-.59.705-.626.142-.057.176-.05.22-.04.045.011.127.052.263.17.235.201.56.671.92 1.161.354.484.791 1.08 1.543 1.33.8.267 1.784-.052 2.671-.846 1.594-1.424 2.235-3.317 2.714-5.051zm11.705 7.023c-.02.014.042-.002.042 0l-.008.035c.05-.2-.028-.04-.034-.035zM79.472 122.45a.198.198 0 0 1 .005.023v.014c-.002-.01-.003-.03-.005-.037zm-.29.732-.006.01-.044.027c.016-.01.033-.024.05-.036z" style="color:#000;fill:#282828;stroke-width:1.02352;-inkscape-stroke:none" transform="translate(-40.698 -95.175)"/>
|
||||
<path d="M76.694 128.845c-.85-.012-1.668.253-2.434.67-.01.592-.015 1.17.109 1.772.323 1.573.422 3.553-.07 5.147-.247.804-.684 1.535-1.347 1.891-.663.356-1.467.296-2.362-.159-.522-.266-1.059-.62-1.487-.757-.223-.072-.392-.096-.522-.069-.13.027-.232.094-.362.27-.53.719-.681 1.823-.497 2.876.177 1.012.418 1.438.543 1.56.143.137.26.154.604.055.548-.158 1.523-.857 2.573-.972l.02-.002.5.058c.686.081 1.247.562 1.622 1.19.372.62.591 1.37.73 2.136.279 1.532.25 3.16.083 4.232-.14.91-.394 1.72-.632 2.53 1.719-.385 3.485-.692 5.307-.36 1.174.214 2.749.574 3.762 1.977l.088.122.046.159c.162.551.16 1.114.024 1.578-.13.45-.348.772-.533 1.023-.181.246-.336.444-.437.606-.102.16-.141.275-.145.336-.01.17 0 .197.07.315.057.1.186.242.39.366.408.246 1.106.414 1.843.45a7.842 7.842 0 0 0 2.174-.21 4.28 4.28 0 0 0 .822-.296c.218-.106.385-.242.377-.233l.029-.031c.025-.035.05-.072.05-.068 0-.004 0-.017-.003-.05a2.733 2.733 0 0 0-.21-.579c-.26-.548-.839-1.333-.822-2.46.01-.657.27-1.21.598-1.576.32-.357.696-.575 1.074-.736.759-.323 1.57-.418 2.054-.458 1.653-.136 3.252.296 4.755.765.457.142.905.29 1.352.434.325-2.258.902-4.247.598-6.217-.071-.46-.25-1.169-.486-1.684-.238-.518-.495-.762-.675-.779-.351-.032-.716.14-1.174.418-.457.277-1.005.665-1.695.742-.745.082-1.406-.291-1.84-.908-.428-.608-.653-1.394-.754-2.196-.203-1.596.016-3.377.794-4.493.568-.813 1.358-.984 2.024-.835.65.146 1.243.51 1.769.779.524.267.99.413 1.237.365a.527.527 0 0 0 .346-.2c.11-.132.235-.373.37-.798.612-1.918.27-3.894-.246-6.054-2.815-.851-5.49-1.534-8.089-.267a.727.727 0 0 0-.223.148c-.024.028-.018.021-.026.056.001-.003-.01.178.07.44.162.522.611 1.29.911 1.978l.004.009.029.063.024.084V133c.162.635.016 1.297-.274 1.727-.272.404-.618.636-.952.81-.675.353-1.399.484-1.724.533a5.888 5.888 0 0 1-3.973-.795c-.512-.311-.876-.594-1.133-1.02-.282-.466-.318-1.084-.172-1.557.252-.814.715-1.266.971-1.89a.663.663 0 0 0 .047-.14c.001-.013 0-.006-.007-.037a.761.761 0 0 0-.184-.268c-.264-.267-.865-.595-1.54-.826-1.356-.462-3.07-.659-3.583-.686-.062-.002-.121-.006-.178-.006z" style="fill:#282828;fill-opacity:1;stroke:none;stroke-width:.991342;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" transform="translate(-40.698 -95.175)"/>
|
||||
</svg>
|
||||
Relearn
|
||||
</a>
|
||||
</div>
|
||||
<form action="../../search.html" method="get"><div class="searchbox default-animation">
|
||||
<button type="submit" title="Search (CTRL+ALT+f)"><i class="fas fa-search"></i></button>
|
||||
<label class="a11y-only" for="search-by">Search</label>
|
||||
<input data-search-input id="search-by" name="search-by" class="search-by" type="search" placeholder="Search...">
|
||||
<span data-search-clear=""><i class="fas fa-times"></i></span>
|
||||
</div></form>
|
||||
<script>
|
||||
var contentLangs=['en'];
|
||||
</script>
|
||||
<script src="../../js/auto-complete.js?1674913745" defer></script>
|
||||
<script src="../../js/lunr/lunr.min.js?1674913745" defer></script>
|
||||
<script src="../../js/lunr/lunr.stemmer.support.min.js?1674913745" defer></script>
|
||||
<script src="../../js/lunr/lunr.multi.min.js?1674913745" defer></script>
|
||||
<script src="../../js/lunr/lunr.en.min.js?1674913745" defer></script>
|
||||
<script src="../../js/search.js?1674913745" defer></script>
|
||||
</div>
|
||||
<div id="content-wrapper" class="highlightable">
|
||||
<ul class="topics collapsible-menu">
|
||||
<li data-nav-id="/basics/index.html" class="dd-item"><input type="checkbox" id="section-df6aa773bd1fbc430ade79f1764e4ce7" aria-controls="subsections-df6aa773bd1fbc430ade79f1764e4ce7" class="toggle"><label class="a11y-only toggle" for="section-df6aa773bd1fbc430ade79f1764e4ce7" >Submenu Basics</label><a href="../../basics/index.html"><b style="display: inline-block; font-weight: 200; padding-left: .3rem; text-align: left; width: 1.1rem;">1.</b> Basics<i class="fas fa-check read-icon"></i></a><ul id="subsections-df6aa773bd1fbc430ade79f1764e4ce7">
|
||||
<li data-nav-id="/basics/migration/index.html" class="dd-item"><a href="../../basics/migration/index.html">What's New<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/basics/requirements/index.html" class="dd-item"><a href="../../basics/requirements/index.html">Requirements<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/basics/installation/index.html" class="dd-item"><a href="../../basics/installation/index.html">Installation<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/basics/configuration/index.html" class="dd-item"><a href="../../basics/configuration/index.html">Configuration<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/basics/customization/index.html" class="dd-item"><a href="../../basics/customization/index.html">Customization<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/basics/generator/index.html" class="dd-item"><a href="../../basics/generator/index.html">Stylesheet generator<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/basics/history/index.html" class="dd-item"><a href="../../basics/history/index.html">History<i class="fas fa-check read-icon"></i></a></li></ul></li>
|
||||
<li data-nav-id="/cont/index.html" class="dd-item"><input type="checkbox" id="section-2291d2894a4301fd505172f85eca0c0a" aria-controls="subsections-2291d2894a4301fd505172f85eca0c0a" class="toggle"><label class="a11y-only toggle" for="section-2291d2894a4301fd505172f85eca0c0a" >Submenu Content</label><a href="../../cont/index.html"><b style="display: inline-block; font-weight: 200; padding-left: .3rem; text-align: left; width: 1.1rem;">2.</b> Content<i class="fas fa-check read-icon"></i></a><ul id="subsections-2291d2894a4301fd505172f85eca0c0a">
|
||||
<li data-nav-id="/cont/pages/index.html" class="dd-item"><a href="../../cont/pages/index.html">Pages organization<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/cont/archetypes/index.html" class="dd-item"><a href="../../cont/archetypes/index.html">Archetypes<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/cont/markdown/index.html" class="dd-item"><a href="../../cont/markdown/index.html">Markdown syntax<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/cont/syntaxhighlight/index.html" class="dd-item"><a href="../../cont/syntaxhighlight/index.html">Code highlighting<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/cont/menushortcuts/index.html" class="dd-item"><a href="../../cont/menushortcuts/index.html">Menu extra shortcuts<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/cont/i18n/index.html" class="dd-item"><a href="../../cont/i18n/index.html">Multilingual and i18n<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/cont/tags/index.html" class="dd-item"><a href="../../cont/tags/index.html">Tags<i class="fas fa-check read-icon"></i></a></li></ul></li>
|
||||
<li data-nav-id="/shortcodes/index.html" class="dd-item"><input type="checkbox" id="section-c0549379138a5c256f6c0600d532453f" aria-controls="subsections-c0549379138a5c256f6c0600d532453f" class="toggle"><label class="a11y-only toggle" for="section-c0549379138a5c256f6c0600d532453f" >Submenu Shortcodes</label><a href="../../shortcodes/index.html"><b style="display: inline-block; font-weight: 200; padding-left: .3rem; text-align: left; width: 1.1rem;">3.</b> Shortcodes<i class="fas fa-check read-icon"></i></a><ul id="subsections-c0549379138a5c256f6c0600d532453f">
|
||||
<li data-nav-id="/shortcodes/attachments/index.html" class="dd-item"><a href="../../shortcodes/attachments/index.html">Attachments<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/badge/index.html" class="dd-item"><a href="../../shortcodes/badge/index.html">Badge<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/button/index.html" class="dd-item"><a href="../../shortcodes/button/index.html">Button<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/children/index.html" class="dd-item"><input type="checkbox" id="section-efce957ff9dad000e250ff868aa3291d" aria-controls="subsections-efce957ff9dad000e250ff868aa3291d" class="toggle"><label class="a11y-only toggle" for="section-efce957ff9dad000e250ff868aa3291d" >Submenu Children</label><a href="../../shortcodes/children/index.html">Children<i class="fas fa-check read-icon"></i></a><ul id="subsections-efce957ff9dad000e250ff868aa3291d">
|
||||
<li data-nav-id="/shortcodes/children/test/index.html" class="dd-item"><a href="../../shortcodes/children/test/index.html">page X<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/children/children-1/index.html" class="dd-item"><input type="checkbox" id="section-c27b80e9c4c5ceb911093893f4f00a2b" aria-controls="subsections-c27b80e9c4c5ceb911093893f4f00a2b" class="toggle"><label class="a11y-only toggle" for="section-c27b80e9c4c5ceb911093893f4f00a2b" >Submenu page 1</label><a href="../../shortcodes/children/children-1/index.html">page 1<i class="fas fa-check read-icon"></i></a><ul id="subsections-c27b80e9c4c5ceb911093893f4f00a2b">
|
||||
<li data-nav-id="/shortcodes/children/children-1/children-1-1/index.html" class="dd-item alwaysopen"><input type="checkbox" id="section-bc0c0185f32af18e77e51e4a5f0a3ba4" aria-controls="subsections-bc0c0185f32af18e77e51e4a5f0a3ba4" class="toggle" checked><label class="a11y-only toggle" for="section-bc0c0185f32af18e77e51e4a5f0a3ba4" >Submenu page 1-1</label><a href="../../shortcodes/children/children-1/children-1-1/index.html">page 1-1<i class="fas fa-check read-icon"></i></a><ul id="subsections-bc0c0185f32af18e77e51e4a5f0a3ba4">
|
||||
<li data-nav-id="/shortcodes/children/children-1/children-1-1/children-1-1-2/index.html" class="dd-item alwaysopen"><input type="checkbox" id="section-9c0a5b93d94f133c09f9cec9eec310a6" aria-controls="subsections-9c0a5b93d94f133c09f9cec9eec310a6" class="toggle" checked><label class="a11y-only toggle" for="section-9c0a5b93d94f133c09f9cec9eec310a6" >Submenu page 1-1-2</label><a href="../../shortcodes/children/children-1/children-1-1/children-1-1-2/index.html">page 1-1-2<i class="fas fa-check read-icon"></i></a><ul id="subsections-9c0a5b93d94f133c09f9cec9eec310a6">
|
||||
<li data-nav-id="/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html" class="dd-item"><a href="../../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html">page 1-1-2-1<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html" class="dd-item"><a href="../../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html">page 1-1-2-2<i class="fas fa-check read-icon"></i></a></li></ul></li>
|
||||
<li data-nav-id="/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html" class="dd-item"><a href="../../shortcodes/children/children-1/children-1-1/children-1-1-3/index.html">page 1-1-3<i class="fas fa-check read-icon"></i></a></li></ul></li></ul></li>
|
||||
<li data-nav-id="/shortcodes/children/children-2/index.html" class="dd-item"><a href="../../shortcodes/children/children-2/index.html">page 2<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/children/children-3/index.html" class="dd-item"><input type="checkbox" id="section-801eeaaa0748a0846cc1e95f3a734fb7" aria-controls="subsections-801eeaaa0748a0846cc1e95f3a734fb7" class="toggle"><label class="a11y-only toggle" for="section-801eeaaa0748a0846cc1e95f3a734fb7" >Submenu page 3</label><a href="../../shortcodes/children/children-3/index.html">page 3<i class="fas fa-check read-icon"></i></a><ul id="subsections-801eeaaa0748a0846cc1e95f3a734fb7">
|
||||
<li data-nav-id="/shortcodes/children/children-3/test3/index.html" class="dd-item"><a href="../../shortcodes/children/children-3/test3/index.html">page 3-1<i class="fas fa-check read-icon"></i></a></li></ul></li></ul></li>
|
||||
<li data-nav-id="/shortcodes/expand/index.html" class="dd-item"><a href="../../shortcodes/expand/index.html">Expand<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/icon/index.html" class="dd-item"><a href="../../shortcodes/icon/index.html">Icon<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/include/index.html" class="dd-item"><a href="../../shortcodes/include/index.html">Include<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/math/index.html" class="dd-item"><a href="../../shortcodes/math/index.html">Math<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/mermaid/index.html" class="dd-item"><a href="../../shortcodes/mermaid/index.html">Mermaid<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/notice/index.html" class="dd-item"><a href="../../shortcodes/notice/index.html">Notice<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/siteparam/index.html" class="dd-item"><a href="../../shortcodes/siteparam/index.html">Site param<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/swagger/index.html" class="dd-item"><a href="../../shortcodes/swagger/index.html">Swagger<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/tabs/index.html" class="dd-item"><a href="../../shortcodes/tabs/index.html">Tabs<i class="fas fa-check read-icon"></i></a></li></ul></li>
|
||||
<li data-nav-id="/dev/index.html" class="dd-item parent"><input type="checkbox" id="section-ad8629dc9507cd96f47ff7ebebbc5d81" aria-controls="subsections-ad8629dc9507cd96f47ff7ebebbc5d81" class="toggle" checked><label class="a11y-only toggle" for="section-ad8629dc9507cd96f47ff7ebebbc5d81" >Submenu Development</label><a href="../../dev/index.html"><b style="display: inline-block; font-weight: 200; padding-left: .3rem; text-align: left; width: 1.1rem;">4.</b> Development<i class="fas fa-check read-icon"></i></a><ul id="subsections-ad8629dc9507cd96f47ff7ebebbc5d81">
|
||||
<li data-nav-id="/dev/contributing/index.html" class="dd-item active"><a href="../../dev/contributing/index.html">Contributing<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/dev/maintaining/index.html" class="dd-item"><a href="../../dev/maintaining/index.html">Issue and Release Management<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/dev/screenshots/index.html" class="dd-item"><a href="../../dev/screenshots/index.html">Screenshots<i class="fas fa-check read-icon"></i></a></li></ul></li>
|
||||
</ul>
|
||||
<div id="shortcuts">
|
||||
<div class="nav-title">More</div>
|
||||
<ul>
|
||||
<li><a class="padding" href="https://github.com/McShelby/hugo-theme-relearn"><i class='fab fa-fw fa-github'></i> GitHub repo</a></li>
|
||||
<li><a class="padding" href="../../more/showcase/index.html"><i class='fas fa-fw fa-camera'></i> Showcases</a></li>
|
||||
<li><a class="padding" href="https://gohugo.io/"><i class='fas fa-fw fa-bookmark'></i> Hugo Documentation</a></li>
|
||||
<li><a class="padding" href="../../more/credits/index.html"><i class='fas fa-fw fa-bullhorn'></i> Credits</a></li>
|
||||
<li><a class="padding" href="../../tags/index.html"><i class='fas fa-fw fa-tags'></i> Tags</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footermargin footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showLangSwitch showVariantSwitch showVisitedLinks showFooter"></div>
|
||||
<hr class="default-animation footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showLangSwitch showVariantSwitch showVisitedLinks showFooter">
|
||||
<div id="prefooter" class="footerLangSwitch footerVariantSwitch footerVisitedLinks showLangSwitch showVariantSwitch showVisitedLinks">
|
||||
<ul>
|
||||
<li id="select-language-container" class="footerLangSwitch showLangSwitch">
|
||||
<div class="padding select-container">
|
||||
<i class="fas fa-language fa-fw"></i>
|
||||
<span> </span>
|
||||
<div class="select-style">
|
||||
<label class="a11y-only" for="select-language">Language</label>
|
||||
<select id="select-language" onchange="location = baseUri + this.value;">
|
||||
<option lang="en" id="en" value="/dev/contributing/index.html" selected>English</option>
|
||||
<option lang="pir" id="pir" value="/pir/dev/contributing/index.html">Arrr! ☠ Pirrrates ☠</option>
|
||||
</select>
|
||||
</div>
|
||||
<div class="select-clear"></div>
|
||||
</div>
|
||||
</li>
|
||||
<li id="select-variant-container" class="footerVariantSwitch showVariantSwitch">
|
||||
<div class="padding select-container">
|
||||
<i class="fas fa-paint-brush fa-fw"></i>
|
||||
<span> </span>
|
||||
<div class="select-style">
|
||||
<label class="a11y-only" for="select-variant">Theme</label>
|
||||
<select id="select-variant" onchange="window.variants && variants.changeVariant( this.value );">
|
||||
<option id="relearn-light" value="relearn-light" selected>Relearn Light</option>
|
||||
<option id="relearn-dark" value="relearn-dark">Relearn Dark</option>
|
||||
<option id="learn" value="learn">Learn</option>
|
||||
<option id="neon" value="neon">Neon</option>
|
||||
<option id="blue" value="blue">Blue</option>
|
||||
<option id="green" value="green">Green</option>
|
||||
<option id="red" value="red">Red</option>
|
||||
</select>
|
||||
</div>
|
||||
<div class="select-clear"></div>
|
||||
</div>
|
||||
<script>window.variants && variants.markSelectedVariant();</script>
|
||||
</li>
|
||||
<li class="footerVisitedLinks showVisitedLinks"><button class="padding" onclick="clearHistory();"><i class="fas fa-history fa-fw"></i> Clear History</button></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="footer" class="footerFooter showFooter">
|
||||
<style>
|
||||
#footer {
|
||||
font-size: 13px;
|
||||
height: 100px;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
padding: 2rem 1rem;
|
||||
text-align: center;
|
||||
min-width: 230px;
|
||||
max-width: 300px;
|
||||
}
|
||||
#footer p {
|
||||
margin: 0;
|
||||
}
|
||||
</style>
|
||||
<a class="github-button" href="https://github.com/McShelby/hugo-theme-relearn/archive/main.zip" data-icon="octicon-cloud-download" aria-label="Download McShelby/hugo-theme-relearn on GitHub">Download</a>
|
||||
<a class="github-button" href="https://github.com/McShelby/hugo-theme-relearn" data-icon="octicon-star" data-show-count="true" aria-label="Star McShelby/hugo-theme-relearn on GitHub">Star</a>
|
||||
<a class="github-button" href="https://github.com/McShelby/hugo-theme-relearn/fork" data-icon="octicon-repo-forked" data-show-count="true" aria-label="Fork McShelby/hugo-theme-relearn on GitHub">Fork</a>
|
||||
<p>Built with <a href="https://github.com/McShelby/hugo-theme-relearn" title="love"><i class="fas fa-heart"></i></a> by <a href="https://gohugo.io/">Hugo</a></p>
|
||||
<script async src="../../js/buttons.js?1674913745"></script>
|
||||
</div>
|
||||
</div>
|
||||
</aside>
|
||||
<script src="../../js/clipboard.min.js?1674913745" defer></script>
|
||||
<script src="../../js/perfect-scrollbar.min.js?1674913745" defer></script>
|
||||
<script src="../../js/featherlight.min.js?1674913745" defer></script>
|
||||
<script src="../../js/theme.js?1674913745" defer></script>
|
||||
</body>
|
||||
</html>
|
||||
209
dev/contributing/index.print.html
Normal file
209
dev/contributing/index.print.html
Normal file
|
|
@ -0,0 +1,209 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en" dir="ltr">
|
||||
<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.110.0">
|
||||
<meta name="generator" content="Relearn 5.10.2+tip">
|
||||
<meta name="robots" content="noindex, nofollow, noarchive, noimageindex">
|
||||
<meta name="description" content="What to know if you want to contribute">
|
||||
<meta name="author" content="Sören Weber">
|
||||
<title>Contributing :: Hugo Relearn Theme</title>
|
||||
<link href="https://McShelby.github.io/hugo-theme-relearn/dev/contributing/index.html" rel="alternate" hreflang="x-default">
|
||||
<link href="https://McShelby.github.io/hugo-theme-relearn/dev/contributing/index.html" rel="alternate" hreflang="en">
|
||||
<link href="https://McShelby.github.io/hugo-theme-relearn/pir/dev/contributing/index.html" rel="alternate" hreflang="pir">
|
||||
<link href="../../images/logo.svg?1674913744" rel="icon" type="image/svg+xml">
|
||||
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
|
||||
<link href="../../css/fontawesome-all.min.css?1674913745" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fontawesome-all.min.css?1674913745" rel="stylesheet"></noscript>
|
||||
<link href="../../css/featherlight.min.css?1674913745" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/featherlight.min.css?1674913745" rel="stylesheet"></noscript>
|
||||
<link href="../../css/auto-complete.css?1674913745" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/auto-complete.css?1674913745" rel="stylesheet"></noscript>
|
||||
<link href="../../css/perfect-scrollbar.min.css?1674913745" rel="stylesheet">
|
||||
<link href="../../css/nucleus.css?1674913745" rel="stylesheet">
|
||||
<link href="../../css/fonts.css?1674913745" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fonts.css?1674913745" rel="stylesheet"></noscript>
|
||||
<link href="../../css/theme.css?1674913745" rel="stylesheet">
|
||||
<link href="../../css/theme-relearn-light.css?1674913745" rel="stylesheet" id="variant-style">
|
||||
<link href="../../css/ie.css?1674913745" rel="stylesheet">
|
||||
<link href="../../css/variant.css?1674913745" rel="stylesheet">
|
||||
<link href="../../css/print.css?1674913745" rel="stylesheet" media="print">
|
||||
<link href="../../css/format-print.css?1674913745" rel="stylesheet">
|
||||
<script src="../../js/url.js?1674913745"></script>
|
||||
<script src="../../js/variant.js?1674913745"></script>
|
||||
<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="../../index.search.js";
|
||||
var root_url="../../";
|
||||
var baseUri=root_url.replace(/\/$/, '');
|
||||
// translations
|
||||
window.T_Copy_to_clipboard = 'Copy to clipboard';
|
||||
window.T_Copied_to_clipboard = 'Copied to clipboard!';
|
||||
window.T_Copy_link_to_clipboard = 'Copy link to clipboard';
|
||||
window.T_Link_copied_to_clipboard = 'Copied link to clipboard!';
|
||||
window.T_No_results_found = 'No results found for \u0022{0}\u0022';
|
||||
window.T_N_results_found = '{1} results found for \u0022{0}\u0022';
|
||||
// some further base stuff
|
||||
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
|
||||
window.variants && variants.init( [ 'relearn-light', 'relearn-dark', 'learn', 'neon', 'blue', 'green', 'red' ] );
|
||||
</script>
|
||||
<script src="../../js/jquery.min.js?1674913745" defer></script>
|
||||
<style>
|
||||
#body img.bg-white {
|
||||
background-color: white;
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body class="mobile-support print disableInlineCopyToClipboard" data-url="../../dev/contributing/index.html">
|
||||
<div id="body" class="default-animation">
|
||||
<div id="sidebar-overlay"></div>
|
||||
<div id="toc-overlay"></div>
|
||||
<nav id="topbar" class="highlightable" dir="ltr">
|
||||
<div>
|
||||
<div id="breadcrumbs">
|
||||
<span id="sidebar-toggle-span">
|
||||
<a href="#" id="sidebar-toggle" title='Menu (CTRL+ALT+n)'><i class="fas fa-bars fa-fw"></i></a>
|
||||
</span>
|
||||
<ol class="links" itemscope itemtype="http://schema.org/BreadcrumbList">
|
||||
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="../../index.html"><span itemprop="name">Hugo Relearn Theme</span></a><meta itemprop="position" content="1"> > </li>
|
||||
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="../../dev/index.html"><span itemprop="name">Development</span></a><meta itemprop="position" content="2"> > </li>
|
||||
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Contributing</span><meta itemprop="position" content="3"></li>
|
||||
</ol>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
<main id="body-inner" class="highlightable default" tabindex="-1">
|
||||
<div class="flex-block-wrapper">
|
||||
<div id="head-tags">
|
||||
</div>
|
||||
<article class="default">
|
||||
<h1 id="contributing">Contributing</h1>
|
||||
|
||||
<h2 id="code-quality">Code Quality</h2>
|
||||
<p>A new release can happen at any time from the <code>main</code> branch of the <a href="https://github.com/McShelby/hugo-theme-relearn" target="_blank">GitHub project</a> without further accknowledgment. This makes it necessary that, every pushed set of changesets into the <code>main</code> branch <strong>must</strong> be self-contained and correct, resulting in a releasable version.</p>
|
||||
<p>Stay simple for the user by focusing on the mantra “convention over configuration”.</p>
|
||||
<p>At installation the site should work reasonable without (m)any configuration.</p>
|
||||
<p>Stay close to the Hugo way.</p>
|
||||
<p>Don’t use npm or any preprocessing, our contributors may not be front-end developers.</p>
|
||||
<p>Document new features in the exampleSite. This also contains entries to the <a href="../../basics/migration/">What’s new</a> page.</p>
|
||||
<p>Don’t break existing features if you don’t have to.</p>
|
||||
<p>Remove reported issue from the browser’s console.</p>
|
||||
<p>Check for unnecessary whitespace and correct indention of your resulting HTML.</p>
|
||||
<p>Be compatible to IE11, at least for main functionality, this means:</p>
|
||||
<ul>
|
||||
<li>test in IE11</li>
|
||||
<li>check caniuse.com</li>
|
||||
<li>don’t use JavaScript arrow functions</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>
|
||||
<p>Write commit messages in the <a href="https://www.conventionalcommits.org/en/v1.0.0/" target="_blank">conventional commit</a> format.</p>
|
||||
<p>Following is an impomplete list of some of the used conventional commit types. Be creative.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Common</th>
|
||||
<th>Feature</th>
|
||||
<th>Structure</th>
|
||||
<th>Shortcodes</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>shortcodes</td>
|
||||
<td>i18n</td>
|
||||
<td>scrollbar</td>
|
||||
<td>expand</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>theme</td>
|
||||
<td>mobile</td>
|
||||
<td>nav</td>
|
||||
<td>icon</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>
|
||||
<td>piratify</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>siteparam</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>swagger</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>tabs</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<footer class="footline">
|
||||
</footer>
|
||||
</article>
|
||||
</div>
|
||||
</main>
|
||||
</div>
|
||||
<script src="../../js/clipboard.min.js?1674913745" defer></script>
|
||||
<script src="../../js/perfect-scrollbar.min.js?1674913745" defer></script>
|
||||
<script src="../../js/featherlight.min.js?1674913745" defer></script>
|
||||
<script src="../../js/theme.js?1674913745" defer></script>
|
||||
</body>
|
||||
</html>
|
||||
10
dev/contributing/index.xml
Normal file
10
dev/contributing/index.xml
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
|
||||
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
|
||||
<channel>
|
||||
<title>Contributing on Hugo Relearn Theme</title>
|
||||
<link>https://McShelby.github.io/hugo-theme-relearn/dev/contributing/index.html</link>
|
||||
<description>Recent content in Contributing on Hugo Relearn Theme</description>
|
||||
<generator>Hugo -- gohugo.io</generator>
|
||||
<language>en</language><atom:link href="https://McShelby.github.io/hugo-theme-relearn/dev/contributing/index.xml" rel="self" type="application/rss+xml" />
|
||||
</channel>
|
||||
</rss>
|
||||
|
|
@ -12,21 +12,21 @@
|
|||
<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">
|
||||
<link href="../images/logo.svg?1674903570" rel="icon" type="image/svg+xml">
|
||||
<link href="../images/logo.svg?1674913744" rel="icon" type="image/svg+xml">
|
||||
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
|
||||
<link href="../css/fontawesome-all.min.css?1674903570" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../css/fontawesome-all.min.css?1674903570" rel="stylesheet"></noscript>
|
||||
<link href="../css/featherlight.min.css?1674903570" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../css/featherlight.min.css?1674903570" rel="stylesheet"></noscript>
|
||||
<link href="../css/auto-complete.css?1674903570" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../css/auto-complete.css?1674903570" rel="stylesheet"></noscript>
|
||||
<link href="../css/perfect-scrollbar.min.css?1674903570" rel="stylesheet">
|
||||
<link href="../css/nucleus.css?1674903570" rel="stylesheet">
|
||||
<link href="../css/fonts.css?1674903570" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../css/fonts.css?1674903570" rel="stylesheet"></noscript>
|
||||
<link href="../css/theme.css?1674903570" rel="stylesheet">
|
||||
<link href="../css/theme-relearn-light.css?1674903570" rel="stylesheet" id="variant-style">
|
||||
<link href="../css/ie.css?1674903570" rel="stylesheet">
|
||||
<link href="../css/variant.css?1674903570" rel="stylesheet">
|
||||
<link href="../css/print.css?1674903570" rel="stylesheet" media="print">
|
||||
<script src="../js/url.js?1674903570"></script>
|
||||
<script src="../js/variant.js?1674903570"></script>
|
||||
<link href="../css/fontawesome-all.min.css?1674913744" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../css/fontawesome-all.min.css?1674913744" rel="stylesheet"></noscript>
|
||||
<link href="../css/featherlight.min.css?1674913744" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../css/featherlight.min.css?1674913744" rel="stylesheet"></noscript>
|
||||
<link href="../css/auto-complete.css?1674913744" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../css/auto-complete.css?1674913744" rel="stylesheet"></noscript>
|
||||
<link href="../css/perfect-scrollbar.min.css?1674913744" rel="stylesheet">
|
||||
<link href="../css/nucleus.css?1674913744" rel="stylesheet">
|
||||
<link href="../css/fonts.css?1674913744" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../css/fonts.css?1674913744" rel="stylesheet"></noscript>
|
||||
<link href="../css/theme.css?1674913744" rel="stylesheet">
|
||||
<link href="../css/theme-relearn-light.css?1674913744" rel="stylesheet" id="variant-style">
|
||||
<link href="../css/ie.css?1674913744" rel="stylesheet">
|
||||
<link href="../css/variant.css?1674913744" rel="stylesheet">
|
||||
<link href="../css/print.css?1674913744" rel="stylesheet" media="print">
|
||||
<script src="../js/url.js?1674913744"></script>
|
||||
<script src="../js/variant.js?1674913744"></script>
|
||||
<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
|
||||
|
|
@ -44,7 +44,7 @@
|
|||
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
|
||||
window.variants && variants.init( [ 'relearn-light', 'relearn-dark', 'learn', 'neon', 'blue', 'green', 'red' ] );
|
||||
</script>
|
||||
<script src="../js/jquery.min.js?1674903570" defer></script>
|
||||
<script src="../js/jquery.min.js?1674913744" defer></script>
|
||||
<style>
|
||||
#body img.bg-white {
|
||||
background-color: white;
|
||||
|
|
@ -58,7 +58,7 @@
|
|||
<nav id="topbar" class="highlightable" dir="ltr">
|
||||
<div>
|
||||
<div class="navigation">
|
||||
<a class="nav nav-next" href="../dev/screenshots/index.html" title="Screenshots (🡒)"><i class="fas fa-chevron-right fa-fw"></i></a>
|
||||
<a class="nav nav-next" href="../dev/contributing/index.html" title="Contributing (🡒)"><i class="fas fa-chevron-right fa-fw"></i></a>
|
||||
</div>
|
||||
<div class="navigation">
|
||||
<a class="nav nav-prev" href="../shortcodes/tabs/index.html" title="Tabs (🡐)"><i class="fas fa-chevron-left fa-fw"></i></a>
|
||||
|
|
@ -96,6 +96,8 @@
|
|||
|
||||
<div class="children children-h2 children-sort-">
|
||||
|
||||
<h2><a href="../dev/contributing/index.html">Contributing</a></h2><p>What to know if you want to contribute</p>
|
||||
<h2><a href="../dev/maintaining/index.html">Issue and Release Management</a></h2><p>What to know as a maintainer</p>
|
||||
<h2><a href="../dev/screenshots/index.html">Screenshots</a></h2><p>Recipe to create various documentation screenshots</p>
|
||||
</div>
|
||||
|
||||
|
|
@ -177,12 +179,12 @@
|
|||
<script>
|
||||
var contentLangs=['en'];
|
||||
</script>
|
||||
<script src="../js/auto-complete.js?1674903571" defer></script>
|
||||
<script src="../js/lunr/lunr.min.js?1674903571" defer></script>
|
||||
<script src="../js/lunr/lunr.stemmer.support.min.js?1674903571" defer></script>
|
||||
<script src="../js/lunr/lunr.multi.min.js?1674903571" defer></script>
|
||||
<script src="../js/lunr/lunr.en.min.js?1674903571" defer></script>
|
||||
<script src="../js/search.js?1674903571" defer></script>
|
||||
<script src="../js/auto-complete.js?1674913745" defer></script>
|
||||
<script src="../js/lunr/lunr.min.js?1674913745" defer></script>
|
||||
<script src="../js/lunr/lunr.stemmer.support.min.js?1674913745" defer></script>
|
||||
<script src="../js/lunr/lunr.multi.min.js?1674913745" defer></script>
|
||||
<script src="../js/lunr/lunr.en.min.js?1674913745" defer></script>
|
||||
<script src="../js/search.js?1674913745" defer></script>
|
||||
</div>
|
||||
<div id="content-wrapper" class="highlightable">
|
||||
<ul class="topics collapsible-menu">
|
||||
|
|
@ -227,6 +229,8 @@
|
|||
<li data-nav-id="/shortcodes/swagger/index.html" class="dd-item"><a href="../shortcodes/swagger/index.html">Swagger<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/tabs/index.html" class="dd-item"><a href="../shortcodes/tabs/index.html">Tabs<i class="fas fa-check read-icon"></i></a></li></ul></li>
|
||||
<li data-nav-id="/dev/index.html" class="dd-item active parent"><input type="checkbox" id="section-ad8629dc9507cd96f47ff7ebebbc5d81" aria-controls="subsections-ad8629dc9507cd96f47ff7ebebbc5d81" class="toggle" checked><label class="a11y-only toggle" for="section-ad8629dc9507cd96f47ff7ebebbc5d81" >Submenu Development</label><a href="../dev/index.html"><b style="display: inline-block; font-weight: 200; padding-left: .3rem; text-align: left; width: 1.1rem;">4.</b> Development<i class="fas fa-check read-icon"></i></a><ul id="subsections-ad8629dc9507cd96f47ff7ebebbc5d81">
|
||||
<li data-nav-id="/dev/contributing/index.html" class="dd-item"><a href="../dev/contributing/index.html">Contributing<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/dev/maintaining/index.html" class="dd-item"><a href="../dev/maintaining/index.html">Issue and Release Management<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/dev/screenshots/index.html" class="dd-item"><a href="../dev/screenshots/index.html">Screenshots<i class="fas fa-check read-icon"></i></a></li></ul></li>
|
||||
</ul>
|
||||
<div id="shortcuts">
|
||||
|
|
@ -300,13 +304,13 @@
|
|||
<a class="github-button" href="https://github.com/McShelby/hugo-theme-relearn" data-icon="octicon-star" data-show-count="true" aria-label="Star McShelby/hugo-theme-relearn on GitHub">Star</a>
|
||||
<a class="github-button" href="https://github.com/McShelby/hugo-theme-relearn/fork" data-icon="octicon-repo-forked" data-show-count="true" aria-label="Fork McShelby/hugo-theme-relearn on GitHub">Fork</a>
|
||||
<p>Built with <a href="https://github.com/McShelby/hugo-theme-relearn" title="love"><i class="fas fa-heart"></i></a> by <a href="https://gohugo.io/">Hugo</a></p>
|
||||
<script async src="../js/buttons.js?1674903571"></script>
|
||||
<script async src="../js/buttons.js?1674913745"></script>
|
||||
</div>
|
||||
</div>
|
||||
</aside>
|
||||
<script src="../js/clipboard.min.js?1674903571" defer></script>
|
||||
<script src="../js/perfect-scrollbar.min.js?1674903571" defer></script>
|
||||
<script src="../js/featherlight.min.js?1674903571" defer></script>
|
||||
<script src="../js/theme.js?1674903571" defer></script>
|
||||
<script src="../js/clipboard.min.js?1674913745" defer></script>
|
||||
<script src="../js/perfect-scrollbar.min.js?1674913745" defer></script>
|
||||
<script src="../js/featherlight.min.js?1674913745" defer></script>
|
||||
<script src="../js/theme.js?1674913745" defer></script>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -12,22 +12,22 @@
|
|||
<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">
|
||||
<link href="../images/logo.svg?1674903570" rel="icon" type="image/svg+xml">
|
||||
<link href="../images/logo.svg?1674913744" rel="icon" type="image/svg+xml">
|
||||
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
|
||||
<link href="../css/fontawesome-all.min.css?1674903572" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../css/fontawesome-all.min.css?1674903572" rel="stylesheet"></noscript>
|
||||
<link href="../css/featherlight.min.css?1674903572" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../css/featherlight.min.css?1674903572" rel="stylesheet"></noscript>
|
||||
<link href="../css/auto-complete.css?1674903572" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../css/auto-complete.css?1674903572" rel="stylesheet"></noscript>
|
||||
<link href="../css/perfect-scrollbar.min.css?1674903572" rel="stylesheet">
|
||||
<link href="../css/nucleus.css?1674903572" rel="stylesheet">
|
||||
<link href="../css/fonts.css?1674903572" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../css/fonts.css?1674903572" rel="stylesheet"></noscript>
|
||||
<link href="../css/theme.css?1674903572" rel="stylesheet">
|
||||
<link href="../css/theme-relearn-light.css?1674903572" rel="stylesheet" id="variant-style">
|
||||
<link href="../css/ie.css?1674903572" rel="stylesheet">
|
||||
<link href="../css/variant.css?1674903572" rel="stylesheet">
|
||||
<link href="../css/print.css?1674903572" rel="stylesheet" media="print">
|
||||
<link href="../css/format-print.css?1674903572" rel="stylesheet">
|
||||
<script src="../js/url.js?1674903572"></script>
|
||||
<script src="../js/variant.js?1674903572"></script>
|
||||
<link href="../css/fontawesome-all.min.css?1674913745" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../css/fontawesome-all.min.css?1674913745" rel="stylesheet"></noscript>
|
||||
<link href="../css/featherlight.min.css?1674913745" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../css/featherlight.min.css?1674913745" rel="stylesheet"></noscript>
|
||||
<link href="../css/auto-complete.css?1674913745" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../css/auto-complete.css?1674913745" rel="stylesheet"></noscript>
|
||||
<link href="../css/perfect-scrollbar.min.css?1674913745" rel="stylesheet">
|
||||
<link href="../css/nucleus.css?1674913745" rel="stylesheet">
|
||||
<link href="../css/fonts.css?1674913745" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../css/fonts.css?1674913745" rel="stylesheet"></noscript>
|
||||
<link href="../css/theme.css?1674913745" rel="stylesheet">
|
||||
<link href="../css/theme-relearn-light.css?1674913745" rel="stylesheet" id="variant-style">
|
||||
<link href="../css/ie.css?1674913745" rel="stylesheet">
|
||||
<link href="../css/variant.css?1674913745" rel="stylesheet">
|
||||
<link href="../css/print.css?1674913745" rel="stylesheet" media="print">
|
||||
<link href="../css/format-print.css?1674913745" rel="stylesheet">
|
||||
<script src="../js/url.js?1674913745"></script>
|
||||
<script src="../js/variant.js?1674913745"></script>
|
||||
<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
|
||||
|
|
@ -45,7 +45,7 @@
|
|||
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
|
||||
window.variants && variants.init( [ 'relearn-light', 'relearn-dark', 'learn', 'neon', 'blue', 'green', 'red' ] );
|
||||
</script>
|
||||
<script src="../js/jquery.min.js?1674903572" defer></script>
|
||||
<script src="../js/jquery.min.js?1674913745" defer></script>
|
||||
<style>
|
||||
#body img.bg-white {
|
||||
background-color: white;
|
||||
|
|
@ -81,6 +81,8 @@
|
|||
|
||||
<div class="children children-h2 children-sort-">
|
||||
|
||||
<h2><a href="../dev/contributing/index.html">Contributing</a></h2><p>What to know if you want to contribute</p>
|
||||
<h2><a href="../dev/maintaining/index.html">Issue and Release Management</a></h2><p>What to know as a maintainer</p>
|
||||
<h2><a href="../dev/screenshots/index.html">Screenshots</a></h2><p>Recipe to create various documentation screenshots</p>
|
||||
</div>
|
||||
|
||||
|
|
@ -91,6 +93,323 @@
|
|||
<section>
|
||||
<h1 class="a11y-only">Subsections of Development</h1>
|
||||
<article class="default">
|
||||
<h1 id="contributing">Contributing</h1>
|
||||
|
||||
<h2 id="code-quality">Code Quality</h2>
|
||||
<p>A new release can happen at any time from the <code>main</code> branch of the <a href="https://github.com/McShelby/hugo-theme-relearn" target="_blank">GitHub project</a> without further accknowledgment. This makes it necessary that, every pushed set of changesets into the <code>main</code> branch <strong>must</strong> be self-contained and correct, resulting in a releasable version.</p>
|
||||
<p>Stay simple for the user by focusing on the mantra “convention over configuration”.</p>
|
||||
<p>At installation the site should work reasonable without (m)any configuration.</p>
|
||||
<p>Stay close to the Hugo way.</p>
|
||||
<p>Don’t use npm or any preprocessing, our contributors may not be front-end developers.</p>
|
||||
<p>Document new features in the exampleSite. This also contains entries to the <a href="../basics/migration/">What’s new</a> page.</p>
|
||||
<p>Don’t break existing features if you don’t have to.</p>
|
||||
<p>Remove reported issue from the browser’s console.</p>
|
||||
<p>Check for unnecessary whitespace and correct indention of your resulting HTML.</p>
|
||||
<p>Be compatible to IE11, at least for main functionality, this means:</p>
|
||||
<ul>
|
||||
<li>test in IE11</li>
|
||||
<li>check caniuse.com</li>
|
||||
<li>don’t use JavaScript arrow functions</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>
|
||||
<p>Write commit messages in the <a href="https://www.conventionalcommits.org/en/v1.0.0/" target="_blank">conventional commit</a> format.</p>
|
||||
<p>Following is an impomplete list of some of the used conventional commit types. Be creative.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Common</th>
|
||||
<th>Feature</th>
|
||||
<th>Structure</th>
|
||||
<th>Shortcodes</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>shortcodes</td>
|
||||
<td>i18n</td>
|
||||
<td>scrollbar</td>
|
||||
<td>expand</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>theme</td>
|
||||
<td>mobile</td>
|
||||
<td>nav</td>
|
||||
<td>icon</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>
|
||||
<td>piratify</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>siteparam</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>swagger</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>tabs</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<footer class="footline">
|
||||
</footer>
|
||||
</article>
|
||||
|
||||
<article class="default">
|
||||
<h1 id="issue-and-release-management">Issue and Release Management</h1>
|
||||
|
||||
<h2 id="semver">Semver</h2>
|
||||
<p>This project tries to follow the <a href="https://semver.org/" target="_blank">semver policy</a> - although not followed 100% in the past.</p>
|
||||
<p>Usually an entry of <span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Breaking</span></span> on the <a href="../basics/migration/">What’s new</a> page causes a new major release number.</p>
|
||||
<p>All other entries on the <a href="../basics/migration/">What’s new</a> page will increase the minor release number.</p>
|
||||
<p>Releases resulting in a new major or minor number are called main release.</p>
|
||||
<p>Releases containing bugixes only, are only increasing the patch release number. Those releases don’t result in announcements on the <a href="../basics/migration/">What’s new</a> page.</p>
|
||||
<p>Entries on the <a href="../basics/migration/">What’s new</a> page are checked and enforced during the <code>version-release</code> GitHub Action.</p>
|
||||
<h2 id="managing-issues">Managing Issues</h2>
|
||||
<p>Issues are categorized and managed by assigning <a href="#labels">labels</a> to it.</p>
|
||||
<p>Once working on an issue, assign it to a fitting maintainer.</p>
|
||||
<p>When done, close the ticket. Once an issue is closed, it needs to be assigned to next release milestone.</p>
|
||||
<h2 id="managing-pull-requests">Managing Pull Requests</h2>
|
||||
<p>If a PR is merged and closed it needs an accompanied issue assigned to. If there is no issue for a PR, the maintainer needs to create one.</p>
|
||||
<p>You can assign multiple PRs to one issue as long as they belong together.</p>
|
||||
<p>Usually set the same labels and milestone for the PR as for the accompanied issue.</p>
|
||||
<h2 id="labels">Labels</h2>
|
||||
<h3 id="kind">Kind</h3>
|
||||
<p>An issue that results in changesets must have exactly one of the following labels. This needs to be assigned latest before release.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Label</th>
|
||||
<th>Description</th>
|
||||
<th>Changelog section</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="badge cstyle default"><span class="badge-content" style="background-color: #5498d8;">documentation</span></span></td>
|
||||
<td>Improvements or additions to documentation</td>
|
||||
<td>-</td>
|
||||
</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 to 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>Something isn’t working</td>
|
||||
<td>Fixes</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="impact">Impact</h3>
|
||||
<p>If the issue would cause a new main release due to <a href="#semver">semver semantics</a> it needs one of the according labels and the matching badge on the <a href="../basics/migration/">What’s new</a> page.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Label</th>
|
||||
<th>Description</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 with existing installations</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="badge cstyle default"><span class="badge-content" style="background-color: #d73a4a;">breaking</span></span></td>
|
||||
<td>Introduces breaking changes with existing installations</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="declination">Declination</h3>
|
||||
<p>If an issue does not result in changesets but is closed anyways, it must have exactly one of the following labels.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Label</th>
|
||||
<th>Description</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>
|
||||
<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>
|
||||
<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>You can assign one further label out of the following list to signal readers that development on an open issue is currently halted for different reasons.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Label</th>
|
||||
<th>Description</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 to 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 valuable 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>
|
||||
<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 in 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 information is needed</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="3rd-party">3rd-Party</h3>
|
||||
<p>If the issue is not caused by a programming error in the themes own code, you can label the causing program or library.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Label</th>
|
||||
<th>Description</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 is a topic related to the browser but not the theme</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="badge cstyle default"><span class="badge-content" style="background-color: #e550a7;">hugo</span></span></td>
|
||||
<td>This is a topic related to Hugo itself but not the theme</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="badge cstyle default"><span class="badge-content" style="background-color: #e550a7;">mermaid</span></span></td>
|
||||
<td>This is a topic related to Mermaid itself but not the theme</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="making-releases">Making Releases</h2>
|
||||
<p>A release is based on a milestone named like the release itself - just the version number, eg: <code>1.2.3</code>. It’s in the maintainers responsiblity to check <a href="#semver">semver semantics</a> of the milestone’s name prior to release and change it if necessary.</p>
|
||||
<p>Making releases is automated by the <code>version-release</code> GitHub Action. It requires the version number of the milestone that should be released. The release will be created from the <code>main</code> branch of the repository.</p>
|
||||
<p>During execution of the action a few things are checked. If a check fails the action fails, resulting in no new release. You can correct the errors afterwards and rerun the action.</p>
|
||||
<p>The following checks will be enforced</p>
|
||||
<ul>
|
||||
<li>the milestone exists</li>
|
||||
<li>there is at least one closed issue assigned to the milestone</li>
|
||||
<li>all assigned issues for this milestone are closed</li>
|
||||
<li>the milestone is not previously released</li>
|
||||
<li>if it’s a main release, there must be a new <code><major>.<minor></code> at the beginning of the <a href="../basics/migration/">What’s new</a> page</li>
|
||||
<li>if it’s a patch release, there must be the <code><major>.<minor></code> from the previous release at the beginning of the <a href="../basics/migration/">What’s new</a> page</li>
|
||||
</ul>
|
||||
<p>After a successful run of the action</p>
|
||||
<ul>
|
||||
<li>the <a href="https://mcshelby.github.io/hugo-theme-relearn/basics/history/index.html" target="_blank">History</a> page is updated</li>
|
||||
<li>the <a href="https://mcshelby.github.io/hugo-theme-relearn/basics/migration/index.html" target="_blank">What’s new</a> page is updated</li>
|
||||
<li>the version number for the <code><meta generator></code> is updated</li>
|
||||
<li>the updated files are commited</li>
|
||||
<li>the milestone is closed</li>
|
||||
<li>the repository is tagged with the version number</li>
|
||||
<li>a new entry in the <a href="https://github.com/McShelby/hugo-theme-relearn/releases" target="_blank">GitHub release list</a> with the according changelog will be created</li>
|
||||
<li>the <a href="https://mcshelby.github.io/hugo-theme-relearn/index.html" target="_blank">official documentation</a> is built and deployed</li>
|
||||
<li>the version number for the <code><meta generator></code> is updated to a temporary and commited (this helps to determine if users are running directly on the main branch or are using releases)</li>
|
||||
<li>a new milestone for the next patch release is created (this can later be renamed to a main release if necessary)</li>
|
||||
</ul>
|
||||
|
||||
<footer class="footline">
|
||||
</footer>
|
||||
</article>
|
||||
|
||||
<article class="default">
|
||||
<h1 id="screenshots">Screenshots</h1>
|
||||
|
||||
<p>Sometimes screenshots need to be redone. This page explains how to create the different screenshots, tools and settings</p>
|
||||
|
|
@ -179,9 +498,9 @@
|
|||
</section> </div>
|
||||
</main>
|
||||
</div>
|
||||
<script src="../js/clipboard.min.js?1674903572" defer></script>
|
||||
<script src="../js/perfect-scrollbar.min.js?1674903572" defer></script>
|
||||
<script src="../js/featherlight.min.js?1674903572" defer></script>
|
||||
<script src="../js/theme.js?1674903572" defer></script>
|
||||
<script src="../js/clipboard.min.js?1674913745" defer></script>
|
||||
<script src="../js/perfect-scrollbar.min.js?1674913745" defer></script>
|
||||
<script src="../js/featherlight.min.js?1674913745" defer></script>
|
||||
<script src="../js/theme.js?1674913745" defer></script>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -6,6 +6,27 @@
|
|||
<description>Recent content in Development on Hugo Relearn Theme</description>
|
||||
<generator>Hugo -- gohugo.io</generator>
|
||||
<language>en</language><atom:link href="https://McShelby.github.io/hugo-theme-relearn/dev/index.xml" rel="self" type="application/rss+xml" />
|
||||
<item>
|
||||
<title>Contributing</title>
|
||||
<link>https://McShelby.github.io/hugo-theme-relearn/dev/contributing/index.html</link>
|
||||
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
||||
<guid>https://McShelby.github.io/hugo-theme-relearn/dev/contributing/index.html</guid>
|
||||
<description>Code Quality A new release can happen at any time from the main branch of the GitHub project without further accknowledgment. This makes it necessary that, every pushed set of changesets into the main branch must be self-contained and correct, resulting in a releasable version.
|
||||
Stay simple for the user by focusing on the mantra &ldquo;convention over configuration&rdquo;.
|
||||
At installation the site should work reasonable without (m)any configuration.
|
||||
Stay close to the Hugo way.</description>
|
||||
</item>
|
||||
<item>
|
||||
<title>Issue and Release Management</title>
|
||||
<link>https://McShelby.github.io/hugo-theme-relearn/dev/maintaining/index.html</link>
|
||||
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
||||
<guid>https://McShelby.github.io/hugo-theme-relearn/dev/maintaining/index.html</guid>
|
||||
<description>Semver This project tries to follow the semver policy - although not followed 100% in the past.
|
||||
Usually an entry of Breaking on the What&rsquo;s new page causes a new major release number.
|
||||
All other entries on the What&rsquo;s new page will increase the minor release number.
|
||||
Releases resulting in a new major or minor number are called main release.
|
||||
Releases containing bugixes only, are only increasing the patch release number.</description>
|
||||
</item>
|
||||
<item>
|
||||
<title>Screenshots</title>
|
||||
<link>https://McShelby.github.io/hugo-theme-relearn/dev/screenshots/index.html</link>
|
||||
|
|
|
|||
514
dev/maintaining/index.html
Normal file
514
dev/maintaining/index.html
Normal file
|
|
@ -0,0 +1,514 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en" dir="ltr">
|
||||
<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.110.0">
|
||||
<meta name="generator" content="Relearn 5.10.2+tip">
|
||||
<meta name="robots" content="noindex, nofollow, noarchive, noimageindex">
|
||||
<meta name="description" content="What to know as a maintainer">
|
||||
<meta name="author" content="Sören Weber">
|
||||
<title>Issue and Release Management :: Hugo Relearn Theme</title>
|
||||
<link href="https://McShelby.github.io/hugo-theme-relearn/dev/maintaining/index.html" rel="alternate" hreflang="x-default">
|
||||
<link href="https://McShelby.github.io/hugo-theme-relearn/dev/maintaining/index.html" rel="alternate" hreflang="en">
|
||||
<link href="https://McShelby.github.io/hugo-theme-relearn/pir/dev/maintaining/index.html" rel="alternate" hreflang="pir">
|
||||
<link href="../../images/logo.svg?1674913744" rel="icon" type="image/svg+xml">
|
||||
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
|
||||
<link href="../../css/fontawesome-all.min.css?1674913744" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fontawesome-all.min.css?1674913744" rel="stylesheet"></noscript>
|
||||
<link href="../../css/featherlight.min.css?1674913744" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/featherlight.min.css?1674913744" rel="stylesheet"></noscript>
|
||||
<link href="../../css/auto-complete.css?1674913744" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/auto-complete.css?1674913744" rel="stylesheet"></noscript>
|
||||
<link href="../../css/perfect-scrollbar.min.css?1674913744" rel="stylesheet">
|
||||
<link href="../../css/nucleus.css?1674913744" rel="stylesheet">
|
||||
<link href="../../css/fonts.css?1674913744" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fonts.css?1674913744" rel="stylesheet"></noscript>
|
||||
<link href="../../css/theme.css?1674913744" rel="stylesheet">
|
||||
<link href="../../css/theme-relearn-light.css?1674913744" rel="stylesheet" id="variant-style">
|
||||
<link href="../../css/ie.css?1674913744" rel="stylesheet">
|
||||
<link href="../../css/variant.css?1674913744" rel="stylesheet">
|
||||
<link href="../../css/print.css?1674913744" rel="stylesheet" media="print">
|
||||
<script src="../../js/url.js?1674913744"></script>
|
||||
<script src="../../js/variant.js?1674913744"></script>
|
||||
<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="../../index.search.js";
|
||||
var root_url="../../";
|
||||
var baseUri=root_url.replace(/\/$/, '');
|
||||
// translations
|
||||
window.T_Copy_to_clipboard = 'Copy to clipboard';
|
||||
window.T_Copied_to_clipboard = 'Copied to clipboard!';
|
||||
window.T_Copy_link_to_clipboard = 'Copy link to clipboard';
|
||||
window.T_Link_copied_to_clipboard = 'Copied link to clipboard!';
|
||||
window.T_No_results_found = 'No results found for \u0022{0}\u0022';
|
||||
window.T_N_results_found = '{1} results found for \u0022{0}\u0022';
|
||||
// some further base stuff
|
||||
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
|
||||
window.variants && variants.init( [ 'relearn-light', 'relearn-dark', 'learn', 'neon', 'blue', 'green', 'red' ] );
|
||||
</script>
|
||||
<script src="../../js/jquery.min.js?1674913744" defer></script>
|
||||
<style>
|
||||
#body img.bg-white {
|
||||
background-color: white;
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body class="mobile-support html disableInlineCopyToClipboard" data-url="../../dev/maintaining/index.html">
|
||||
<div id="body" class="default-animation">
|
||||
<div id="sidebar-overlay"></div>
|
||||
<div id="toc-overlay"></div>
|
||||
<nav id="topbar" class="highlightable" dir="ltr">
|
||||
<div>
|
||||
<div class="navigation">
|
||||
<a class="nav nav-next" href="../../dev/screenshots/index.html" title="Screenshots (🡒)"><i class="fas fa-chevron-right fa-fw"></i></a>
|
||||
</div>
|
||||
<div class="navigation">
|
||||
<a class="nav nav-prev" href="../../dev/contributing/index.html" title="Contributing (🡐)"><i class="fas fa-chevron-left fa-fw"></i></a>
|
||||
</div>
|
||||
<div id="top-print-link">
|
||||
<a class="print-link" title='Print whole chapter (CTRL+ALT+p)' href="../../dev/maintaining/index.print.html">
|
||||
<i class="fas fa-print fa-fw"></i>
|
||||
</a>
|
||||
</div>
|
||||
<div id="top-github-link">
|
||||
<a class="github-link" title='Edit (CTRL+ALT+w)' href="https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/dev/maintaining/_index.en.md" target="_blank">
|
||||
<i class="fas fa-pen fa-fw"></i>
|
||||
</a>
|
||||
</div>
|
||||
<div id="breadcrumbs">
|
||||
<span id="sidebar-toggle-span">
|
||||
<a href="#" id="sidebar-toggle" title='Menu (CTRL+ALT+n)'><i class="fas fa-bars fa-fw"></i></a>
|
||||
</span>
|
||||
<span id="toc-menu" title='Table of Contents (CTRL+ALT+t)'><i class="fas fa-list-alt fa-fw"></i></span>
|
||||
<ol class="links" itemscope itemtype="http://schema.org/BreadcrumbList">
|
||||
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="../../index.html"><span itemprop="name">Hugo Relearn Theme</span></a><meta itemprop="position" content="1"> > </li>
|
||||
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="../../dev/index.html"><span itemprop="name">Development</span></a><meta itemprop="position" content="2"> > </li>
|
||||
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Issue and Release Management</span><meta itemprop="position" content="3"></li>
|
||||
</ol>
|
||||
</div>
|
||||
<div class="default-animation progress">
|
||||
<div class="toc-wrapper" dir="ltr">
|
||||
<nav id="TableOfContents">
|
||||
<ul>
|
||||
<li><a href="#semver">Semver</a></li>
|
||||
<li><a href="#managing-issues">Managing Issues</a></li>
|
||||
<li><a href="#managing-pull-requests">Managing Pull Requests</a></li>
|
||||
<li><a href="#labels">Labels</a>
|
||||
<ul>
|
||||
<li><a href="#kind">Kind</a></li>
|
||||
<li><a href="#impact">Impact</a></li>
|
||||
<li><a href="#declination">Declination</a></li>
|
||||
<li><a href="#halt">Halt</a></li>
|
||||
<li><a href="#3rd-party">3rd-Party</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#making-releases">Making Releases</a></li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
<main id="body-inner" class="highlightable default" tabindex="-1">
|
||||
<div class="flex-block-wrapper">
|
||||
<div id="head-tags">
|
||||
</div>
|
||||
<article class="default">
|
||||
<h1 id="issue-and-release-management">Issue and Release Management</h1>
|
||||
|
||||
<h2 id="semver">Semver</h2>
|
||||
<p>This project tries to follow the <a href="https://semver.org/" target="_blank">semver policy</a> - although not followed 100% in the past.</p>
|
||||
<p>Usually an entry of <span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Breaking</span></span> on the <a href="../../basics/migration/">What’s new</a> page causes a new major release number.</p>
|
||||
<p>All other entries on the <a href="../../basics/migration/">What’s new</a> page will increase the minor release number.</p>
|
||||
<p>Releases resulting in a new major or minor number are called main release.</p>
|
||||
<p>Releases containing bugixes only, are only increasing the patch release number. Those releases don’t result in announcements on the <a href="../../basics/migration/">What’s new</a> page.</p>
|
||||
<p>Entries on the <a href="../../basics/migration/">What’s new</a> page are checked and enforced during the <code>version-release</code> GitHub Action.</p>
|
||||
<h2 id="managing-issues">Managing Issues</h2>
|
||||
<p>Issues are categorized and managed by assigning <a href="#labels">labels</a> to it.</p>
|
||||
<p>Once working on an issue, assign it to a fitting maintainer.</p>
|
||||
<p>When done, close the ticket. Once an issue is closed, it needs to be assigned to next release milestone.</p>
|
||||
<h2 id="managing-pull-requests">Managing Pull Requests</h2>
|
||||
<p>If a PR is merged and closed it needs an accompanied issue assigned to. If there is no issue for a PR, the maintainer needs to create one.</p>
|
||||
<p>You can assign multiple PRs to one issue as long as they belong together.</p>
|
||||
<p>Usually set the same labels and milestone for the PR as for the accompanied issue.</p>
|
||||
<h2 id="labels">Labels</h2>
|
||||
<h3 id="kind">Kind</h3>
|
||||
<p>An issue that results in changesets must have exactly one of the following labels. This needs to be assigned latest before release.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Label</th>
|
||||
<th>Description</th>
|
||||
<th>Changelog section</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="badge cstyle default"><span class="badge-content" style="background-color: #5498d8;">documentation</span></span></td>
|
||||
<td>Improvements or additions to documentation</td>
|
||||
<td>-</td>
|
||||
</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 to 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>Something isn’t working</td>
|
||||
<td>Fixes</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="impact">Impact</h3>
|
||||
<p>If the issue would cause a new main release due to <a href="#semver">semver semantics</a> it needs one of the according labels and the matching badge on the <a href="../../basics/migration/">What’s new</a> page.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Label</th>
|
||||
<th>Description</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 with existing installations</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="badge cstyle default"><span class="badge-content" style="background-color: #d73a4a;">breaking</span></span></td>
|
||||
<td>Introduces breaking changes with existing installations</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="declination">Declination</h3>
|
||||
<p>If an issue does not result in changesets but is closed anyways, it must have exactly one of the following labels.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Label</th>
|
||||
<th>Description</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>
|
||||
<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>
|
||||
<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>You can assign one further label out of the following list to signal readers that development on an open issue is currently halted for different reasons.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Label</th>
|
||||
<th>Description</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 to 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 valuable 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>
|
||||
<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 in 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 information is needed</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="3rd-party">3rd-Party</h3>
|
||||
<p>If the issue is not caused by a programming error in the themes own code, you can label the causing program or library.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Label</th>
|
||||
<th>Description</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 is a topic related to the browser but not the theme</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="badge cstyle default"><span class="badge-content" style="background-color: #e550a7;">hugo</span></span></td>
|
||||
<td>This is a topic related to Hugo itself but not the theme</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="badge cstyle default"><span class="badge-content" style="background-color: #e550a7;">mermaid</span></span></td>
|
||||
<td>This is a topic related to Mermaid itself but not the theme</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="making-releases">Making Releases</h2>
|
||||
<p>A release is based on a milestone named like the release itself - just the version number, eg: <code>1.2.3</code>. It’s in the maintainers responsiblity to check <a href="#semver">semver semantics</a> of the milestone’s name prior to release and change it if necessary.</p>
|
||||
<p>Making releases is automated by the <code>version-release</code> GitHub Action. It requires the version number of the milestone that should be released. The release will be created from the <code>main</code> branch of the repository.</p>
|
||||
<p>During execution of the action a few things are checked. If a check fails the action fails, resulting in no new release. You can correct the errors afterwards and rerun the action.</p>
|
||||
<p>The following checks will be enforced</p>
|
||||
<ul>
|
||||
<li>the milestone exists</li>
|
||||
<li>there is at least one closed issue assigned to the milestone</li>
|
||||
<li>all assigned issues for this milestone are closed</li>
|
||||
<li>the milestone is not previously released</li>
|
||||
<li>if it’s a main release, there must be a new <code><major>.<minor></code> at the beginning of the <a href="../../basics/migration/">What’s new</a> page</li>
|
||||
<li>if it’s a patch release, there must be the <code><major>.<minor></code> from the previous release at the beginning of the <a href="../../basics/migration/">What’s new</a> page</li>
|
||||
</ul>
|
||||
<p>After a successful run of the action</p>
|
||||
<ul>
|
||||
<li>the <a href="https://mcshelby.github.io/hugo-theme-relearn/basics/history/index.html" target="_blank">History</a> page is updated</li>
|
||||
<li>the <a href="https://mcshelby.github.io/hugo-theme-relearn/basics/migration/index.html" target="_blank">What’s new</a> page is updated</li>
|
||||
<li>the version number for the <code><meta generator></code> is updated</li>
|
||||
<li>the updated files are commited</li>
|
||||
<li>the milestone is closed</li>
|
||||
<li>the repository is tagged with the version number</li>
|
||||
<li>a new entry in the <a href="https://github.com/McShelby/hugo-theme-relearn/releases" target="_blank">GitHub release list</a> with the according changelog will be created</li>
|
||||
<li>the <a href="https://mcshelby.github.io/hugo-theme-relearn/index.html" target="_blank">official documentation</a> is built and deployed</li>
|
||||
<li>the version number for the <code><meta generator></code> is updated to a temporary and commited (this helps to determine if users are running directly on the main branch or are using releases)</li>
|
||||
<li>a new milestone for the next patch release is created (this can later be renamed to a main release if necessary)</li>
|
||||
</ul>
|
||||
|
||||
<footer class="footline">
|
||||
</footer>
|
||||
</article>
|
||||
</div>
|
||||
</main>
|
||||
</div>
|
||||
<aside id="sidebar" class="default-animation showVisitedLinks" dir="ltr">
|
||||
<div id="header-wrapper" class="default-animation">
|
||||
<div id="header" class="default-animation">
|
||||
<style>
|
||||
#logo svg,
|
||||
#logo svg * {
|
||||
color: #282828;
|
||||
color: var(--MENU-SECTIONS-BG-color);
|
||||
fill: #282828 !important;
|
||||
fill: var(--MENU-SECTIONS-BG-color) !important;
|
||||
opacity: .945;
|
||||
}
|
||||
a#logo {
|
||||
color: #282828;
|
||||
color: var(--MENU-SECTIONS-BG-color);
|
||||
font-family: 'Work Sans', 'Helvetica', 'Tahoma', 'Geneva', 'Arial', sans-serif;
|
||||
font-size: 30px;
|
||||
font-weight: 300;
|
||||
margin-top: -13px;
|
||||
max-width: 60%;
|
||||
text-transform: uppercase;
|
||||
width: 226px;
|
||||
white-space: nowrap;
|
||||
}
|
||||
a#logo:hover {
|
||||
color: #282828;
|
||||
color: var(--MENU-SECTIONS-BG-color);
|
||||
}
|
||||
#logo svg {
|
||||
margin-bottom: -20px;
|
||||
margin-left: -23.5px;
|
||||
width: 40.5%;
|
||||
}
|
||||
@media only all and (max-width: 59.938em) {
|
||||
a#logo {
|
||||
font-size: 25px;
|
||||
margin-top: -3px;
|
||||
}
|
||||
#logo svg {
|
||||
margin-bottom: -12px;
|
||||
margin-left: -23px;
|
||||
}
|
||||
}
|
||||
@media all and (-ms-high-contrast:none) {
|
||||
/* IE11s understanding of positioning is weird at best */
|
||||
a#logo {
|
||||
margin-top: -58px;
|
||||
}
|
||||
#logo svg {
|
||||
margin-bottom: -62px;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
<a id="logo" href="../../index.html">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64.044 64.044">
|
||||
<path d="M46.103 136.34c-.642-.394-1.222-2.242-1.98-2.358-.76-.117-1.353.506-1.618 1.519-.266 1.012-.446 4.188.173 5.538.213.435.482.787 1.03.845.547.057.967-.504 1.45-1.027.482-.523.437-.9 1.142-.612.705.289 1.051.4 1.586 1.229.535.828 1.085 4.043.868 5.598-.241 1.458-.531 2.8-.59 4.088.26.075.517.148.772.217 2.68.724 5.373 1.037 7.873.02.001-.028.01-.105.008-.11-.048-.165-.18-.41-.36-.698-.18-.29-.414-.645-.586-1.114a3.212 3.212 0 0 1-.125-1.735c.056-.21.153-.342.249-.475 1.237-1.193 2.932-1.373 4.244-1.384.557-.004 1.389.016 2.198.255.809.239 1.706.724 2.068 1.843.187.578.114 1.17-.043 1.623-.153.438-.369.783-.545 1.091-.178.31-.329.6-.401.821-.007.02-.003.071-.005.094 2.256 1.008 4.716.91 7.189.398.55-.114 1.11-.247 1.673-.377.344-1.085.678-2.145.852-3.208.124-.752.158-2.311-.078-3.538-.118-.613-.306-1.15-.52-1.489-.221-.349-.413-.501-.747-.538-.243-.027-.51.013-.796.098-.67.223-1.33.606-1.966.76l-.008.002-.109.032c-.556.152-1.233.158-1.797-.36-.556-.51-.89-1.367-1.117-2.596-.283-1.528-.075-3.279.89-4.518l.071-.09h.07c.65-.71 1.485-.802 2.16-.599.706.213 1.333.629 1.772.84.736.354 1.185.319 1.475.171.291-.148.5-.439.668-.955.332-1.017.301-2.819.022-4.106-.148-.684-.13-1.292-.13-1.883-1.558-.463-3.067-.982-4.574-1.208-1.128-.169-2.263-.173-3.298.164-.13.046-.256.095-.38.15-.373.164-.633.342-.805.52-.077.098-.081.105-.087.21-.004.068.031.289.13.571.1.282.256.634.467 1.03.279.524.448 1.063.431 1.618a2.12 2.12 0 0 1-.499 1.309 1.757 1.757 0 0 1-.62.51h-.002c-.515.291-1.107.404-1.723.464-.86.083-1.787.026-2.598-.097-.806-.123-1.47-.28-1.948-.555-.444-.256-.79-.547-1.037-.925a2.273 2.273 0 0 1-.356-1.301c.029-.837.403-1.437.625-1.897.111-.23.191-.433.236-.583.045-.15.044-.25.046-.24-.005-.029-.127-.355-1.015-.741-1.138-.495-2.322-.673-3.533-.668h-.015a9.711 9.711 0 0 0-.521.016h-.002c-1.163.057-2.35.308-3.541.569.383 1.531.79 2.753.818 4.502-.096 1.297.158 2.114-1.03 2.935-.85.588-1.508.729-2.15.335" style="fill:#282828;fill-opacity:1;stroke:none;stroke-width:1.03763;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" transform="translate(-40.698 -95.175)"/>
|
||||
<path d="M61.472 101.34v.002c-.3-.003-.603.01-.894.04-.544.055-1.39.165-1.778.306-1.238.364.13 2.344.41 2.913.28.569.285 2.03.14 2.134-.144.103-.375.261-.934.345-.56.084.03-.037-1.589.086-1.62.122-5.506.29-8.265.248-.022.26-.036.521-.097.808-.309 1.442-.63 3.163-.494 4.074.071.473.168.65.414.8.23.14.737.235 1.62-.004.834-.227 1.3-.442 1.887-.456.595-.016 1.555.472 1.965.717.411.245-.03-.008.002 0s.128.05.176.102c.049.053-.276-.523.104.199.379.721.72 3.256.002 4.68-.46.913-1.01 1.49-1.64 1.711-.63.22-1.229.067-1.734-.135-.881-.353-1.584-.7-2.205-.647-1.199 1.94-1.186 4.17-.6 6.602.097.397.212.814.327 1.23 2.68-.556 5.542-1.016 8.337.132 1.064.437 1.73 1.015 1.902 1.857.169.831-.193 1.508-.438 1.986-.122.238-.23.46-.307.642-.07.164-.096.28-.104.324.069.429.309.723.686.945.385.227.89.355 1.35.423.723.104 1.567.152 2.287.086.693-.064 1.032-.338 1.241-.544a2.447 2.447 0 0 0 .303-.437.175.175 0 0 0 .013-.035c-.004-.066-.037-.246-.195-.527-.46-.816-.87-1.595-.817-2.51.028-.476.218-.938.529-1.288.304-.343.698-.586 1.186-.79 1.442-.606 2.96-.609 4.372-.409 1.525.216 2.963.679 4.378 1.083.226-2.09.784-3.9.592-5.77-.058-.565-.287-1.333-.598-1.827-.32-.508-.59-.717-1.036-.642-.648.11-1.472.935-2.707 1.078-.791.092-1.494-.267-1.95-.86-.45-.583-.678-1.335-.78-2.101-.202-1.525.031-3.229.89-4.27.615-.747 1.45-.887 2.15-.74.687.145 1.307.492 1.857.745v-.002c.546.252 1.033.388 1.281.344a.547.547 0 0 0 .353-.188c.113-.124.242-.35.384-.75.604-1.712.206-3.68-.303-5.654-.667.145-1.336.293-2.018.413-1.341.236-2.73.392-4.136.273-.656-.055-1.695-.085-2.58-.476-.442-.195-.903-.514-1.157-1.093-.259-.591-.205-1.313.08-2.014.223-.64 1.082-2.178.692-2.585-.391-.407-1.651-.56-2.554-.571z" style="fill:#282828;fill-opacity:1;stroke:none;stroke-width:.992837;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" transform="translate(-40.698 -95.175)"/>
|
||||
<path d="M83.128 98.116c-.484 1.875-1.057 3.757-2.486 5.033-.638.57-1.13.666-1.483.548-.401-.134-.715-.506-1.058-.973-.338-.461-.655-.97-1.076-1.332-.192-.165-.404-.315-.683-.38-.279-.066-.599-.02-.9.102-.489.196-.89.58-1.28 1.047a6.1 6.1 0 0 0-.985 1.632c-.234.591-.356 1.174-.277 1.713.072.487.392.977.905 1.185.463.187.926.156 1.36.154.433 0 .843.01 1.242.147.55.189.79.736.822 1.368.034.66-.145 1.412-.393 1.988l-.008.021c-.74 1.705-1.946 2.893-3.004 4.349l-.664.915.979.099c.924.092 1.788.26 2.468.675.46.281 1.806 1.205 2.794 2.222.497.513.888 1.031 1.047 1.502.078.231.095.422.05.6a.93.93 0 0 1-.345.474c-.301.223-.606.395-.864.532l-.354.186c-.107.058-.189.087-.345.228a.637.637 0 0 1 .062-.045l-.064.041-.209.236-.103.343s.003.126.007.152c.003.017.003.007.004.015v.002c.016.195.061.307.133.476a4.1 4.1 0 0 0 .32.596 5.7 5.7 0 0 0 2.8 2.258c.284.108.908.321 1.548.36.33.02.59.015.912-.13h.002c.08-.037.228-.095.382-.281.153-.186.19-.355.212-.445l.019-.075.003-.078c.023-.585-.037-1.296.072-1.899.153-.657.435-.956 1.009-.909 2.771.239 4.74 1.955 6.693 3.83l.742.714.279-1.155c.55-2.29 1.093-4.464 2.928-5.977.692-.57 1.184-.642 1.527-.509.39.151.676.536.996.995.319.458.605.926 1.07 1.212.194.119.464.232.784.209.32-.024.638-.163.988-.384 1.022-.645 1.778-1.756 2.086-2.942.136-.522.102-.991-.046-1.301-.158-.334-.433-.553-.754-.707-.653-.314-1.468-.373-2.094-.486-.825-.15-1.22-.475-1.345-.878-.13-.417 0-.953.335-1.61.6-1.173 1.887-2.602 3.13-3.911l.498-.526-.449-.432c-1.545-1.49-3.163-3.01-5.252-3.715h-.002c-.473-.16-1.097-.413-1.73-.424h-.003c-.311-.004-.596.04-.883.24v.002c-.22.155-.483.537-.583.937l-.008.036-.006.038c-.116.773-.06 1.467-.217 1.995-.063.212-.198.418-.359.507-.202.111-.492.153-.976.072-.582-.097-1.978-.69-3.021-1.503-.523-.407-.934-.85-1.117-1.3a1.153 1.153 0 0 1-.083-.63c.03-.184.1-.477.308-.593.21-.116.941-.32 1.377-.642h.002c.192-.141.403-.367.518-.64.114-.275.127-.526.123-.774-.006-.142-.036-.192-.08-.3a8.417 8.417 0 0 0-3-3.027c-1.226-.725-2.585-1.135-3.927-1.539-.434-.12-.844-.111-1.02.466zm.912.947c1.186.364 2.357.718 3.345 1.303 1.035.612 1.864 1.488 2.507 2.528-.514.263-1.095.5-1.44.79-.345.29-.729.914-.815 1.434-.084.509 0 .968.155 1.347.301.74.85 1.276 1.44 1.735 1.18.92 2.554 1.545 3.47 1.698.604.1 1.186.088 1.739-.216.594-.327.935-.911 1.088-1.427.264-.884.193-1.664.262-2.17h.1c.3.006.926.206 1.417.371 1.646.554 3.044 1.773 4.431 3.089-1.102 1.174-2.222 2.423-2.888 3.73-.42.823-.73 1.789-.453 2.687.283.913 1.1 1.415 2.138 1.603.691.126 1.472.226 1.84.403.19.091.258.182.278.223.03.064.058.075-.023.387-.21.804-.761 1.598-1.413 2.01-.247.155-.365.183-.407.187-.042.003-.061.002-.172-.066-.144-.088-.455-.473-.772-.929-.317-.454-.714-1.07-1.452-1.356-.783-.304-1.776-.022-2.713.75-1.942 1.6-2.626 3.764-3.146 5.8-1.802-1.676-3.772-3.138-6.589-3.517h-.002c-.346-.095-1.013-.031-1.293.143-.735.501-1.005 1.132-1.168 2.007-.125.69-.082 1.216-.074 1.659-.055.006-.046.01-.104.006-.42-.026-1.035-.215-1.244-.295-.947-.361-1.774-1.006-2.314-1.857-.054-.085-.072-.132-.109-.2l.027-.016c.284-.15.656-.36 1.045-.648.44-.327.789-.798.93-1.35a2.4 2.4 0 0 0-.068-1.379c-.254-.751-.753-1.353-1.295-1.911-1.09-1.124-2.452-2.049-2.99-2.378-.609-.372-1.303-.44-1.981-.56.875-1.094 1.878-2.251 2.596-3.921.294-.823.543-1.907.513-2.658-.049-.97-.489-2.013-1.52-2.367-.579-.2-1.131-.204-1.58-.203-.45.002-.786-.006-.97-.08h-.002c-.264-.107-.236-.108-.268-.33-.025-.17.021-.553.183-.962a4.67 4.67 0 0 1 .725-1.192c.29-.348.617-.59.705-.626.142-.057.176-.05.22-.04.045.011.127.052.263.17.235.201.56.671.92 1.161.354.484.791 1.08 1.543 1.33.8.267 1.784-.052 2.671-.846 1.594-1.424 2.235-3.317 2.714-5.051zm11.705 7.023c-.02.014.042-.002.042 0l-.008.035c.05-.2-.028-.04-.034-.035zM79.472 122.45a.198.198 0 0 1 .005.023v.014c-.002-.01-.003-.03-.005-.037zm-.29.732-.006.01-.044.027c.016-.01.033-.024.05-.036z" style="color:#000;fill:#282828;stroke-width:1.02352;-inkscape-stroke:none" transform="translate(-40.698 -95.175)"/>
|
||||
<path d="M76.694 128.845c-.85-.012-1.668.253-2.434.67-.01.592-.015 1.17.109 1.772.323 1.573.422 3.553-.07 5.147-.247.804-.684 1.535-1.347 1.891-.663.356-1.467.296-2.362-.159-.522-.266-1.059-.62-1.487-.757-.223-.072-.392-.096-.522-.069-.13.027-.232.094-.362.27-.53.719-.681 1.823-.497 2.876.177 1.012.418 1.438.543 1.56.143.137.26.154.604.055.548-.158 1.523-.857 2.573-.972l.02-.002.5.058c.686.081 1.247.562 1.622 1.19.372.62.591 1.37.73 2.136.279 1.532.25 3.16.083 4.232-.14.91-.394 1.72-.632 2.53 1.719-.385 3.485-.692 5.307-.36 1.174.214 2.749.574 3.762 1.977l.088.122.046.159c.162.551.16 1.114.024 1.578-.13.45-.348.772-.533 1.023-.181.246-.336.444-.437.606-.102.16-.141.275-.145.336-.01.17 0 .197.07.315.057.1.186.242.39.366.408.246 1.106.414 1.843.45a7.842 7.842 0 0 0 2.174-.21 4.28 4.28 0 0 0 .822-.296c.218-.106.385-.242.377-.233l.029-.031c.025-.035.05-.072.05-.068 0-.004 0-.017-.003-.05a2.733 2.733 0 0 0-.21-.579c-.26-.548-.839-1.333-.822-2.46.01-.657.27-1.21.598-1.576.32-.357.696-.575 1.074-.736.759-.323 1.57-.418 2.054-.458 1.653-.136 3.252.296 4.755.765.457.142.905.29 1.352.434.325-2.258.902-4.247.598-6.217-.071-.46-.25-1.169-.486-1.684-.238-.518-.495-.762-.675-.779-.351-.032-.716.14-1.174.418-.457.277-1.005.665-1.695.742-.745.082-1.406-.291-1.84-.908-.428-.608-.653-1.394-.754-2.196-.203-1.596.016-3.377.794-4.493.568-.813 1.358-.984 2.024-.835.65.146 1.243.51 1.769.779.524.267.99.413 1.237.365a.527.527 0 0 0 .346-.2c.11-.132.235-.373.37-.798.612-1.918.27-3.894-.246-6.054-2.815-.851-5.49-1.534-8.089-.267a.727.727 0 0 0-.223.148c-.024.028-.018.021-.026.056.001-.003-.01.178.07.44.162.522.611 1.29.911 1.978l.004.009.029.063.024.084V133c.162.635.016 1.297-.274 1.727-.272.404-.618.636-.952.81-.675.353-1.399.484-1.724.533a5.888 5.888 0 0 1-3.973-.795c-.512-.311-.876-.594-1.133-1.02-.282-.466-.318-1.084-.172-1.557.252-.814.715-1.266.971-1.89a.663.663 0 0 0 .047-.14c.001-.013 0-.006-.007-.037a.761.761 0 0 0-.184-.268c-.264-.267-.865-.595-1.54-.826-1.356-.462-3.07-.659-3.583-.686-.062-.002-.121-.006-.178-.006z" style="fill:#282828;fill-opacity:1;stroke:none;stroke-width:.991342;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" transform="translate(-40.698 -95.175)"/>
|
||||
</svg>
|
||||
Relearn
|
||||
</a>
|
||||
</div>
|
||||
<form action="../../search.html" method="get"><div class="searchbox default-animation">
|
||||
<button type="submit" title="Search (CTRL+ALT+f)"><i class="fas fa-search"></i></button>
|
||||
<label class="a11y-only" for="search-by">Search</label>
|
||||
<input data-search-input id="search-by" name="search-by" class="search-by" type="search" placeholder="Search...">
|
||||
<span data-search-clear=""><i class="fas fa-times"></i></span>
|
||||
</div></form>
|
||||
<script>
|
||||
var contentLangs=['en'];
|
||||
</script>
|
||||
<script src="../../js/auto-complete.js?1674913745" defer></script>
|
||||
<script src="../../js/lunr/lunr.min.js?1674913745" defer></script>
|
||||
<script src="../../js/lunr/lunr.stemmer.support.min.js?1674913745" defer></script>
|
||||
<script src="../../js/lunr/lunr.multi.min.js?1674913745" defer></script>
|
||||
<script src="../../js/lunr/lunr.en.min.js?1674913745" defer></script>
|
||||
<script src="../../js/search.js?1674913745" defer></script>
|
||||
</div>
|
||||
<div id="content-wrapper" class="highlightable">
|
||||
<ul class="topics collapsible-menu">
|
||||
<li data-nav-id="/basics/index.html" class="dd-item"><input type="checkbox" id="section-df6aa773bd1fbc430ade79f1764e4ce7" aria-controls="subsections-df6aa773bd1fbc430ade79f1764e4ce7" class="toggle"><label class="a11y-only toggle" for="section-df6aa773bd1fbc430ade79f1764e4ce7" >Submenu Basics</label><a href="../../basics/index.html"><b style="display: inline-block; font-weight: 200; padding-left: .3rem; text-align: left; width: 1.1rem;">1.</b> Basics<i class="fas fa-check read-icon"></i></a><ul id="subsections-df6aa773bd1fbc430ade79f1764e4ce7">
|
||||
<li data-nav-id="/basics/migration/index.html" class="dd-item"><a href="../../basics/migration/index.html">What's New<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/basics/requirements/index.html" class="dd-item"><a href="../../basics/requirements/index.html">Requirements<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/basics/installation/index.html" class="dd-item"><a href="../../basics/installation/index.html">Installation<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/basics/configuration/index.html" class="dd-item"><a href="../../basics/configuration/index.html">Configuration<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/basics/customization/index.html" class="dd-item"><a href="../../basics/customization/index.html">Customization<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/basics/generator/index.html" class="dd-item"><a href="../../basics/generator/index.html">Stylesheet generator<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/basics/history/index.html" class="dd-item"><a href="../../basics/history/index.html">History<i class="fas fa-check read-icon"></i></a></li></ul></li>
|
||||
<li data-nav-id="/cont/index.html" class="dd-item"><input type="checkbox" id="section-2291d2894a4301fd505172f85eca0c0a" aria-controls="subsections-2291d2894a4301fd505172f85eca0c0a" class="toggle"><label class="a11y-only toggle" for="section-2291d2894a4301fd505172f85eca0c0a" >Submenu Content</label><a href="../../cont/index.html"><b style="display: inline-block; font-weight: 200; padding-left: .3rem; text-align: left; width: 1.1rem;">2.</b> Content<i class="fas fa-check read-icon"></i></a><ul id="subsections-2291d2894a4301fd505172f85eca0c0a">
|
||||
<li data-nav-id="/cont/pages/index.html" class="dd-item"><a href="../../cont/pages/index.html">Pages organization<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/cont/archetypes/index.html" class="dd-item"><a href="../../cont/archetypes/index.html">Archetypes<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/cont/markdown/index.html" class="dd-item"><a href="../../cont/markdown/index.html">Markdown syntax<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/cont/syntaxhighlight/index.html" class="dd-item"><a href="../../cont/syntaxhighlight/index.html">Code highlighting<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/cont/menushortcuts/index.html" class="dd-item"><a href="../../cont/menushortcuts/index.html">Menu extra shortcuts<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/cont/i18n/index.html" class="dd-item"><a href="../../cont/i18n/index.html">Multilingual and i18n<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/cont/tags/index.html" class="dd-item"><a href="../../cont/tags/index.html">Tags<i class="fas fa-check read-icon"></i></a></li></ul></li>
|
||||
<li data-nav-id="/shortcodes/index.html" class="dd-item"><input type="checkbox" id="section-c0549379138a5c256f6c0600d532453f" aria-controls="subsections-c0549379138a5c256f6c0600d532453f" class="toggle"><label class="a11y-only toggle" for="section-c0549379138a5c256f6c0600d532453f" >Submenu Shortcodes</label><a href="../../shortcodes/index.html"><b style="display: inline-block; font-weight: 200; padding-left: .3rem; text-align: left; width: 1.1rem;">3.</b> Shortcodes<i class="fas fa-check read-icon"></i></a><ul id="subsections-c0549379138a5c256f6c0600d532453f">
|
||||
<li data-nav-id="/shortcodes/attachments/index.html" class="dd-item"><a href="../../shortcodes/attachments/index.html">Attachments<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/badge/index.html" class="dd-item"><a href="../../shortcodes/badge/index.html">Badge<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/button/index.html" class="dd-item"><a href="../../shortcodes/button/index.html">Button<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/children/index.html" class="dd-item"><input type="checkbox" id="section-efce957ff9dad000e250ff868aa3291d" aria-controls="subsections-efce957ff9dad000e250ff868aa3291d" class="toggle"><label class="a11y-only toggle" for="section-efce957ff9dad000e250ff868aa3291d" >Submenu Children</label><a href="../../shortcodes/children/index.html">Children<i class="fas fa-check read-icon"></i></a><ul id="subsections-efce957ff9dad000e250ff868aa3291d">
|
||||
<li data-nav-id="/shortcodes/children/test/index.html" class="dd-item"><a href="../../shortcodes/children/test/index.html">page X<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/children/children-1/index.html" class="dd-item"><input type="checkbox" id="section-c27b80e9c4c5ceb911093893f4f00a2b" aria-controls="subsections-c27b80e9c4c5ceb911093893f4f00a2b" class="toggle"><label class="a11y-only toggle" for="section-c27b80e9c4c5ceb911093893f4f00a2b" >Submenu page 1</label><a href="../../shortcodes/children/children-1/index.html">page 1<i class="fas fa-check read-icon"></i></a><ul id="subsections-c27b80e9c4c5ceb911093893f4f00a2b">
|
||||
<li data-nav-id="/shortcodes/children/children-1/children-1-1/index.html" class="dd-item alwaysopen"><input type="checkbox" id="section-bc0c0185f32af18e77e51e4a5f0a3ba4" aria-controls="subsections-bc0c0185f32af18e77e51e4a5f0a3ba4" class="toggle" checked><label class="a11y-only toggle" for="section-bc0c0185f32af18e77e51e4a5f0a3ba4" >Submenu page 1-1</label><a href="../../shortcodes/children/children-1/children-1-1/index.html">page 1-1<i class="fas fa-check read-icon"></i></a><ul id="subsections-bc0c0185f32af18e77e51e4a5f0a3ba4">
|
||||
<li data-nav-id="/shortcodes/children/children-1/children-1-1/children-1-1-2/index.html" class="dd-item alwaysopen"><input type="checkbox" id="section-9c0a5b93d94f133c09f9cec9eec310a6" aria-controls="subsections-9c0a5b93d94f133c09f9cec9eec310a6" class="toggle" checked><label class="a11y-only toggle" for="section-9c0a5b93d94f133c09f9cec9eec310a6" >Submenu page 1-1-2</label><a href="../../shortcodes/children/children-1/children-1-1/children-1-1-2/index.html">page 1-1-2<i class="fas fa-check read-icon"></i></a><ul id="subsections-9c0a5b93d94f133c09f9cec9eec310a6">
|
||||
<li data-nav-id="/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html" class="dd-item"><a href="../../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html">page 1-1-2-1<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html" class="dd-item"><a href="../../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html">page 1-1-2-2<i class="fas fa-check read-icon"></i></a></li></ul></li>
|
||||
<li data-nav-id="/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html" class="dd-item"><a href="../../shortcodes/children/children-1/children-1-1/children-1-1-3/index.html">page 1-1-3<i class="fas fa-check read-icon"></i></a></li></ul></li></ul></li>
|
||||
<li data-nav-id="/shortcodes/children/children-2/index.html" class="dd-item"><a href="../../shortcodes/children/children-2/index.html">page 2<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/children/children-3/index.html" class="dd-item"><input type="checkbox" id="section-801eeaaa0748a0846cc1e95f3a734fb7" aria-controls="subsections-801eeaaa0748a0846cc1e95f3a734fb7" class="toggle"><label class="a11y-only toggle" for="section-801eeaaa0748a0846cc1e95f3a734fb7" >Submenu page 3</label><a href="../../shortcodes/children/children-3/index.html">page 3<i class="fas fa-check read-icon"></i></a><ul id="subsections-801eeaaa0748a0846cc1e95f3a734fb7">
|
||||
<li data-nav-id="/shortcodes/children/children-3/test3/index.html" class="dd-item"><a href="../../shortcodes/children/children-3/test3/index.html">page 3-1<i class="fas fa-check read-icon"></i></a></li></ul></li></ul></li>
|
||||
<li data-nav-id="/shortcodes/expand/index.html" class="dd-item"><a href="../../shortcodes/expand/index.html">Expand<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/icon/index.html" class="dd-item"><a href="../../shortcodes/icon/index.html">Icon<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/include/index.html" class="dd-item"><a href="../../shortcodes/include/index.html">Include<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/math/index.html" class="dd-item"><a href="../../shortcodes/math/index.html">Math<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/mermaid/index.html" class="dd-item"><a href="../../shortcodes/mermaid/index.html">Mermaid<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/notice/index.html" class="dd-item"><a href="../../shortcodes/notice/index.html">Notice<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/siteparam/index.html" class="dd-item"><a href="../../shortcodes/siteparam/index.html">Site param<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/swagger/index.html" class="dd-item"><a href="../../shortcodes/swagger/index.html">Swagger<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/tabs/index.html" class="dd-item"><a href="../../shortcodes/tabs/index.html">Tabs<i class="fas fa-check read-icon"></i></a></li></ul></li>
|
||||
<li data-nav-id="/dev/index.html" class="dd-item parent"><input type="checkbox" id="section-ad8629dc9507cd96f47ff7ebebbc5d81" aria-controls="subsections-ad8629dc9507cd96f47ff7ebebbc5d81" class="toggle" checked><label class="a11y-only toggle" for="section-ad8629dc9507cd96f47ff7ebebbc5d81" >Submenu Development</label><a href="../../dev/index.html"><b style="display: inline-block; font-weight: 200; padding-left: .3rem; text-align: left; width: 1.1rem;">4.</b> Development<i class="fas fa-check read-icon"></i></a><ul id="subsections-ad8629dc9507cd96f47ff7ebebbc5d81">
|
||||
<li data-nav-id="/dev/contributing/index.html" class="dd-item"><a href="../../dev/contributing/index.html">Contributing<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/dev/maintaining/index.html" class="dd-item active"><a href="../../dev/maintaining/index.html">Issue and Release Management<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/dev/screenshots/index.html" class="dd-item"><a href="../../dev/screenshots/index.html">Screenshots<i class="fas fa-check read-icon"></i></a></li></ul></li>
|
||||
</ul>
|
||||
<div id="shortcuts">
|
||||
<div class="nav-title">More</div>
|
||||
<ul>
|
||||
<li><a class="padding" href="https://github.com/McShelby/hugo-theme-relearn"><i class='fab fa-fw fa-github'></i> GitHub repo</a></li>
|
||||
<li><a class="padding" href="../../more/showcase/index.html"><i class='fas fa-fw fa-camera'></i> Showcases</a></li>
|
||||
<li><a class="padding" href="https://gohugo.io/"><i class='fas fa-fw fa-bookmark'></i> Hugo Documentation</a></li>
|
||||
<li><a class="padding" href="../../more/credits/index.html"><i class='fas fa-fw fa-bullhorn'></i> Credits</a></li>
|
||||
<li><a class="padding" href="../../tags/index.html"><i class='fas fa-fw fa-tags'></i> Tags</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footermargin footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showLangSwitch showVariantSwitch showVisitedLinks showFooter"></div>
|
||||
<hr class="default-animation footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showLangSwitch showVariantSwitch showVisitedLinks showFooter">
|
||||
<div id="prefooter" class="footerLangSwitch footerVariantSwitch footerVisitedLinks showLangSwitch showVariantSwitch showVisitedLinks">
|
||||
<ul>
|
||||
<li id="select-language-container" class="footerLangSwitch showLangSwitch">
|
||||
<div class="padding select-container">
|
||||
<i class="fas fa-language fa-fw"></i>
|
||||
<span> </span>
|
||||
<div class="select-style">
|
||||
<label class="a11y-only" for="select-language">Language</label>
|
||||
<select id="select-language" onchange="location = baseUri + this.value;">
|
||||
<option lang="en" id="en" value="/dev/maintaining/index.html" selected>English</option>
|
||||
<option lang="pir" id="pir" value="/pir/dev/maintaining/index.html">Arrr! ☠ Pirrrates ☠</option>
|
||||
</select>
|
||||
</div>
|
||||
<div class="select-clear"></div>
|
||||
</div>
|
||||
</li>
|
||||
<li id="select-variant-container" class="footerVariantSwitch showVariantSwitch">
|
||||
<div class="padding select-container">
|
||||
<i class="fas fa-paint-brush fa-fw"></i>
|
||||
<span> </span>
|
||||
<div class="select-style">
|
||||
<label class="a11y-only" for="select-variant">Theme</label>
|
||||
<select id="select-variant" onchange="window.variants && variants.changeVariant( this.value );">
|
||||
<option id="relearn-light" value="relearn-light" selected>Relearn Light</option>
|
||||
<option id="relearn-dark" value="relearn-dark">Relearn Dark</option>
|
||||
<option id="learn" value="learn">Learn</option>
|
||||
<option id="neon" value="neon">Neon</option>
|
||||
<option id="blue" value="blue">Blue</option>
|
||||
<option id="green" value="green">Green</option>
|
||||
<option id="red" value="red">Red</option>
|
||||
</select>
|
||||
</div>
|
||||
<div class="select-clear"></div>
|
||||
</div>
|
||||
<script>window.variants && variants.markSelectedVariant();</script>
|
||||
</li>
|
||||
<li class="footerVisitedLinks showVisitedLinks"><button class="padding" onclick="clearHistory();"><i class="fas fa-history fa-fw"></i> Clear History</button></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="footer" class="footerFooter showFooter">
|
||||
<style>
|
||||
#footer {
|
||||
font-size: 13px;
|
||||
height: 100px;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
padding: 2rem 1rem;
|
||||
text-align: center;
|
||||
min-width: 230px;
|
||||
max-width: 300px;
|
||||
}
|
||||
#footer p {
|
||||
margin: 0;
|
||||
}
|
||||
</style>
|
||||
<a class="github-button" href="https://github.com/McShelby/hugo-theme-relearn/archive/main.zip" data-icon="octicon-cloud-download" aria-label="Download McShelby/hugo-theme-relearn on GitHub">Download</a>
|
||||
<a class="github-button" href="https://github.com/McShelby/hugo-theme-relearn" data-icon="octicon-star" data-show-count="true" aria-label="Star McShelby/hugo-theme-relearn on GitHub">Star</a>
|
||||
<a class="github-button" href="https://github.com/McShelby/hugo-theme-relearn/fork" data-icon="octicon-repo-forked" data-show-count="true" aria-label="Fork McShelby/hugo-theme-relearn on GitHub">Fork</a>
|
||||
<p>Built with <a href="https://github.com/McShelby/hugo-theme-relearn" title="love"><i class="fas fa-heart"></i></a> by <a href="https://gohugo.io/">Hugo</a></p>
|
||||
<script async src="../../js/buttons.js?1674913745"></script>
|
||||
</div>
|
||||
</div>
|
||||
</aside>
|
||||
<script src="../../js/clipboard.min.js?1674913745" defer></script>
|
||||
<script src="../../js/perfect-scrollbar.min.js?1674913745" defer></script>
|
||||
<script src="../../js/featherlight.min.js?1674913745" defer></script>
|
||||
<script src="../../js/theme.js?1674913745" defer></script>
|
||||
</body>
|
||||
</html>
|
||||
276
dev/maintaining/index.print.html
Normal file
276
dev/maintaining/index.print.html
Normal file
|
|
@ -0,0 +1,276 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en" dir="ltr">
|
||||
<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.110.0">
|
||||
<meta name="generator" content="Relearn 5.10.2+tip">
|
||||
<meta name="robots" content="noindex, nofollow, noarchive, noimageindex">
|
||||
<meta name="description" content="What to know as a maintainer">
|
||||
<meta name="author" content="Sören Weber">
|
||||
<title>Issue and Release Management :: Hugo Relearn Theme</title>
|
||||
<link href="https://McShelby.github.io/hugo-theme-relearn/dev/maintaining/index.html" rel="alternate" hreflang="x-default">
|
||||
<link href="https://McShelby.github.io/hugo-theme-relearn/dev/maintaining/index.html" rel="alternate" hreflang="en">
|
||||
<link href="https://McShelby.github.io/hugo-theme-relearn/pir/dev/maintaining/index.html" rel="alternate" hreflang="pir">
|
||||
<link href="../../images/logo.svg?1674913744" rel="icon" type="image/svg+xml">
|
||||
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
|
||||
<link href="../../css/fontawesome-all.min.css?1674913745" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fontawesome-all.min.css?1674913745" rel="stylesheet"></noscript>
|
||||
<link href="../../css/featherlight.min.css?1674913745" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/featherlight.min.css?1674913745" rel="stylesheet"></noscript>
|
||||
<link href="../../css/auto-complete.css?1674913745" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/auto-complete.css?1674913745" rel="stylesheet"></noscript>
|
||||
<link href="../../css/perfect-scrollbar.min.css?1674913745" rel="stylesheet">
|
||||
<link href="../../css/nucleus.css?1674913745" rel="stylesheet">
|
||||
<link href="../../css/fonts.css?1674913745" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fonts.css?1674913745" rel="stylesheet"></noscript>
|
||||
<link href="../../css/theme.css?1674913745" rel="stylesheet">
|
||||
<link href="../../css/theme-relearn-light.css?1674913745" rel="stylesheet" id="variant-style">
|
||||
<link href="../../css/ie.css?1674913745" rel="stylesheet">
|
||||
<link href="../../css/variant.css?1674913745" rel="stylesheet">
|
||||
<link href="../../css/print.css?1674913745" rel="stylesheet" media="print">
|
||||
<link href="../../css/format-print.css?1674913745" rel="stylesheet">
|
||||
<script src="../../js/url.js?1674913745"></script>
|
||||
<script src="../../js/variant.js?1674913745"></script>
|
||||
<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="../../index.search.js";
|
||||
var root_url="../../";
|
||||
var baseUri=root_url.replace(/\/$/, '');
|
||||
// translations
|
||||
window.T_Copy_to_clipboard = 'Copy to clipboard';
|
||||
window.T_Copied_to_clipboard = 'Copied to clipboard!';
|
||||
window.T_Copy_link_to_clipboard = 'Copy link to clipboard';
|
||||
window.T_Link_copied_to_clipboard = 'Copied link to clipboard!';
|
||||
window.T_No_results_found = 'No results found for \u0022{0}\u0022';
|
||||
window.T_N_results_found = '{1} results found for \u0022{0}\u0022';
|
||||
// some further base stuff
|
||||
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
|
||||
window.variants && variants.init( [ 'relearn-light', 'relearn-dark', 'learn', 'neon', 'blue', 'green', 'red' ] );
|
||||
</script>
|
||||
<script src="../../js/jquery.min.js?1674913745" defer></script>
|
||||
<style>
|
||||
#body img.bg-white {
|
||||
background-color: white;
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body class="mobile-support print disableInlineCopyToClipboard" data-url="../../dev/maintaining/index.html">
|
||||
<div id="body" class="default-animation">
|
||||
<div id="sidebar-overlay"></div>
|
||||
<div id="toc-overlay"></div>
|
||||
<nav id="topbar" class="highlightable" dir="ltr">
|
||||
<div>
|
||||
<div id="breadcrumbs">
|
||||
<span id="sidebar-toggle-span">
|
||||
<a href="#" id="sidebar-toggle" title='Menu (CTRL+ALT+n)'><i class="fas fa-bars fa-fw"></i></a>
|
||||
</span>
|
||||
<ol class="links" itemscope itemtype="http://schema.org/BreadcrumbList">
|
||||
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="../../index.html"><span itemprop="name">Hugo Relearn Theme</span></a><meta itemprop="position" content="1"> > </li>
|
||||
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="../../dev/index.html"><span itemprop="name">Development</span></a><meta itemprop="position" content="2"> > </li>
|
||||
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Issue and Release Management</span><meta itemprop="position" content="3"></li>
|
||||
</ol>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
<main id="body-inner" class="highlightable default" tabindex="-1">
|
||||
<div class="flex-block-wrapper">
|
||||
<div id="head-tags">
|
||||
</div>
|
||||
<article class="default">
|
||||
<h1 id="issue-and-release-management">Issue and Release Management</h1>
|
||||
|
||||
<h2 id="semver">Semver</h2>
|
||||
<p>This project tries to follow the <a href="https://semver.org/" target="_blank">semver policy</a> - although not followed 100% in the past.</p>
|
||||
<p>Usually an entry of <span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Breaking</span></span> on the <a href="../../basics/migration/">What’s new</a> page causes a new major release number.</p>
|
||||
<p>All other entries on the <a href="../../basics/migration/">What’s new</a> page will increase the minor release number.</p>
|
||||
<p>Releases resulting in a new major or minor number are called main release.</p>
|
||||
<p>Releases containing bugixes only, are only increasing the patch release number. Those releases don’t result in announcements on the <a href="../../basics/migration/">What’s new</a> page.</p>
|
||||
<p>Entries on the <a href="../../basics/migration/">What’s new</a> page are checked and enforced during the <code>version-release</code> GitHub Action.</p>
|
||||
<h2 id="managing-issues">Managing Issues</h2>
|
||||
<p>Issues are categorized and managed by assigning <a href="#labels">labels</a> to it.</p>
|
||||
<p>Once working on an issue, assign it to a fitting maintainer.</p>
|
||||
<p>When done, close the ticket. Once an issue is closed, it needs to be assigned to next release milestone.</p>
|
||||
<h2 id="managing-pull-requests">Managing Pull Requests</h2>
|
||||
<p>If a PR is merged and closed it needs an accompanied issue assigned to. If there is no issue for a PR, the maintainer needs to create one.</p>
|
||||
<p>You can assign multiple PRs to one issue as long as they belong together.</p>
|
||||
<p>Usually set the same labels and milestone for the PR as for the accompanied issue.</p>
|
||||
<h2 id="labels">Labels</h2>
|
||||
<h3 id="kind">Kind</h3>
|
||||
<p>An issue that results in changesets must have exactly one of the following labels. This needs to be assigned latest before release.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Label</th>
|
||||
<th>Description</th>
|
||||
<th>Changelog section</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="badge cstyle default"><span class="badge-content" style="background-color: #5498d8;">documentation</span></span></td>
|
||||
<td>Improvements or additions to documentation</td>
|
||||
<td>-</td>
|
||||
</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 to 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>Something isn’t working</td>
|
||||
<td>Fixes</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="impact">Impact</h3>
|
||||
<p>If the issue would cause a new main release due to <a href="#semver">semver semantics</a> it needs one of the according labels and the matching badge on the <a href="../../basics/migration/">What’s new</a> page.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Label</th>
|
||||
<th>Description</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 with existing installations</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="badge cstyle default"><span class="badge-content" style="background-color: #d73a4a;">breaking</span></span></td>
|
||||
<td>Introduces breaking changes with existing installations</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="declination">Declination</h3>
|
||||
<p>If an issue does not result in changesets but is closed anyways, it must have exactly one of the following labels.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Label</th>
|
||||
<th>Description</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>
|
||||
<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>
|
||||
<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>You can assign one further label out of the following list to signal readers that development on an open issue is currently halted for different reasons.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Label</th>
|
||||
<th>Description</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 to 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 valuable 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>
|
||||
<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 in 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 information is needed</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="3rd-party">3rd-Party</h3>
|
||||
<p>If the issue is not caused by a programming error in the themes own code, you can label the causing program or library.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Label</th>
|
||||
<th>Description</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 is a topic related to the browser but not the theme</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="badge cstyle default"><span class="badge-content" style="background-color: #e550a7;">hugo</span></span></td>
|
||||
<td>This is a topic related to Hugo itself but not the theme</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="badge cstyle default"><span class="badge-content" style="background-color: #e550a7;">mermaid</span></span></td>
|
||||
<td>This is a topic related to Mermaid itself but not the theme</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="making-releases">Making Releases</h2>
|
||||
<p>A release is based on a milestone named like the release itself - just the version number, eg: <code>1.2.3</code>. It’s in the maintainers responsiblity to check <a href="#semver">semver semantics</a> of the milestone’s name prior to release and change it if necessary.</p>
|
||||
<p>Making releases is automated by the <code>version-release</code> GitHub Action. It requires the version number of the milestone that should be released. The release will be created from the <code>main</code> branch of the repository.</p>
|
||||
<p>During execution of the action a few things are checked. If a check fails the action fails, resulting in no new release. You can correct the errors afterwards and rerun the action.</p>
|
||||
<p>The following checks will be enforced</p>
|
||||
<ul>
|
||||
<li>the milestone exists</li>
|
||||
<li>there is at least one closed issue assigned to the milestone</li>
|
||||
<li>all assigned issues for this milestone are closed</li>
|
||||
<li>the milestone is not previously released</li>
|
||||
<li>if it’s a main release, there must be a new <code><major>.<minor></code> at the beginning of the <a href="../../basics/migration/">What’s new</a> page</li>
|
||||
<li>if it’s a patch release, there must be the <code><major>.<minor></code> from the previous release at the beginning of the <a href="../../basics/migration/">What’s new</a> page</li>
|
||||
</ul>
|
||||
<p>After a successful run of the action</p>
|
||||
<ul>
|
||||
<li>the <a href="https://mcshelby.github.io/hugo-theme-relearn/basics/history/index.html" target="_blank">History</a> page is updated</li>
|
||||
<li>the <a href="https://mcshelby.github.io/hugo-theme-relearn/basics/migration/index.html" target="_blank">What’s new</a> page is updated</li>
|
||||
<li>the version number for the <code><meta generator></code> is updated</li>
|
||||
<li>the updated files are commited</li>
|
||||
<li>the milestone is closed</li>
|
||||
<li>the repository is tagged with the version number</li>
|
||||
<li>a new entry in the <a href="https://github.com/McShelby/hugo-theme-relearn/releases" target="_blank">GitHub release list</a> with the according changelog will be created</li>
|
||||
<li>the <a href="https://mcshelby.github.io/hugo-theme-relearn/index.html" target="_blank">official documentation</a> is built and deployed</li>
|
||||
<li>the version number for the <code><meta generator></code> is updated to a temporary and commited (this helps to determine if users are running directly on the main branch or are using releases)</li>
|
||||
<li>a new milestone for the next patch release is created (this can later be renamed to a main release if necessary)</li>
|
||||
</ul>
|
||||
|
||||
<footer class="footline">
|
||||
</footer>
|
||||
</article>
|
||||
</div>
|
||||
</main>
|
||||
</div>
|
||||
<script src="../../js/clipboard.min.js?1674913745" defer></script>
|
||||
<script src="../../js/perfect-scrollbar.min.js?1674913745" defer></script>
|
||||
<script src="../../js/featherlight.min.js?1674913745" defer></script>
|
||||
<script src="../../js/theme.js?1674913745" defer></script>
|
||||
</body>
|
||||
</html>
|
||||
10
dev/maintaining/index.xml
Normal file
10
dev/maintaining/index.xml
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
|
||||
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
|
||||
<channel>
|
||||
<title>Issue and Release Management on Hugo Relearn Theme</title>
|
||||
<link>https://McShelby.github.io/hugo-theme-relearn/dev/maintaining/index.html</link>
|
||||
<description>Recent content in Issue and Release Management on Hugo Relearn Theme</description>
|
||||
<generator>Hugo -- gohugo.io</generator>
|
||||
<language>en</language><atom:link href="https://McShelby.github.io/hugo-theme-relearn/dev/maintaining/index.xml" rel="self" type="application/rss+xml" />
|
||||
</channel>
|
||||
</rss>
|
||||
|
|
@ -12,21 +12,21 @@
|
|||
<link href="https://McShelby.github.io/hugo-theme-relearn/dev/screenshots/index.html" rel="alternate" hreflang="x-default">
|
||||
<link href="https://McShelby.github.io/hugo-theme-relearn/dev/screenshots/index.html" rel="alternate" hreflang="en">
|
||||
<link href="https://McShelby.github.io/hugo-theme-relearn/pir/dev/screenshots/index.html" rel="alternate" hreflang="pir">
|
||||
<link href="../../images/logo.svg?1674903570" rel="icon" type="image/svg+xml">
|
||||
<link href="../../images/logo.svg?1674913744" rel="icon" type="image/svg+xml">
|
||||
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
|
||||
<link href="../../css/fontawesome-all.min.css?1674903570" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fontawesome-all.min.css?1674903570" rel="stylesheet"></noscript>
|
||||
<link href="../../css/featherlight.min.css?1674903570" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/featherlight.min.css?1674903570" rel="stylesheet"></noscript>
|
||||
<link href="../../css/auto-complete.css?1674903570" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/auto-complete.css?1674903570" rel="stylesheet"></noscript>
|
||||
<link href="../../css/perfect-scrollbar.min.css?1674903570" rel="stylesheet">
|
||||
<link href="../../css/nucleus.css?1674903570" rel="stylesheet">
|
||||
<link href="../../css/fonts.css?1674903570" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fonts.css?1674903570" rel="stylesheet"></noscript>
|
||||
<link href="../../css/theme.css?1674903570" rel="stylesheet">
|
||||
<link href="../../css/theme-relearn-light.css?1674903570" rel="stylesheet" id="variant-style">
|
||||
<link href="../../css/ie.css?1674903570" rel="stylesheet">
|
||||
<link href="../../css/variant.css?1674903570" rel="stylesheet">
|
||||
<link href="../../css/print.css?1674903570" rel="stylesheet" media="print">
|
||||
<script src="../../js/url.js?1674903570"></script>
|
||||
<script src="../../js/variant.js?1674903570"></script>
|
||||
<link href="../../css/fontawesome-all.min.css?1674913744" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fontawesome-all.min.css?1674913744" rel="stylesheet"></noscript>
|
||||
<link href="../../css/featherlight.min.css?1674913744" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/featherlight.min.css?1674913744" rel="stylesheet"></noscript>
|
||||
<link href="../../css/auto-complete.css?1674913744" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/auto-complete.css?1674913744" rel="stylesheet"></noscript>
|
||||
<link href="../../css/perfect-scrollbar.min.css?1674913744" rel="stylesheet">
|
||||
<link href="../../css/nucleus.css?1674913744" rel="stylesheet">
|
||||
<link href="../../css/fonts.css?1674913744" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fonts.css?1674913744" rel="stylesheet"></noscript>
|
||||
<link href="../../css/theme.css?1674913744" rel="stylesheet">
|
||||
<link href="../../css/theme-relearn-light.css?1674913744" rel="stylesheet" id="variant-style">
|
||||
<link href="../../css/ie.css?1674913744" rel="stylesheet">
|
||||
<link href="../../css/variant.css?1674913744" rel="stylesheet">
|
||||
<link href="../../css/print.css?1674913744" rel="stylesheet" media="print">
|
||||
<script src="../../js/url.js?1674913744"></script>
|
||||
<script src="../../js/variant.js?1674913744"></script>
|
||||
<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
|
||||
|
|
@ -44,7 +44,7 @@
|
|||
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
|
||||
window.variants && variants.init( [ 'relearn-light', 'relearn-dark', 'learn', 'neon', 'blue', 'green', 'red' ] );
|
||||
</script>
|
||||
<script src="../../js/jquery.min.js?1674903570" defer></script>
|
||||
<script src="../../js/jquery.min.js?1674913744" defer></script>
|
||||
<style>
|
||||
#body img.bg-white {
|
||||
background-color: white;
|
||||
|
|
@ -61,7 +61,7 @@
|
|||
<span class="nav nav-next"><i class="fa fa-chevron-right fa-fw"></i></span>
|
||||
</div>
|
||||
<div class="navigation">
|
||||
<a class="nav nav-prev" href="../../dev/index.html" title="Development (🡐)"><i class="fas fa-chevron-left fa-fw"></i></a>
|
||||
<a class="nav nav-prev" href="../../dev/maintaining/index.html" title="Issue and Release Management (🡐)"><i class="fas fa-chevron-left fa-fw"></i></a>
|
||||
</div>
|
||||
<div id="top-print-link">
|
||||
<a class="print-link" title='Print whole chapter (CTRL+ALT+p)' href="../../dev/screenshots/index.print.html">
|
||||
|
|
@ -270,12 +270,12 @@
|
|||
<script>
|
||||
var contentLangs=['en'];
|
||||
</script>
|
||||
<script src="../../js/auto-complete.js?1674903571" defer></script>
|
||||
<script src="../../js/lunr/lunr.min.js?1674903571" defer></script>
|
||||
<script src="../../js/lunr/lunr.stemmer.support.min.js?1674903571" defer></script>
|
||||
<script src="../../js/lunr/lunr.multi.min.js?1674903571" defer></script>
|
||||
<script src="../../js/lunr/lunr.en.min.js?1674903571" defer></script>
|
||||
<script src="../../js/search.js?1674903571" defer></script>
|
||||
<script src="../../js/auto-complete.js?1674913745" defer></script>
|
||||
<script src="../../js/lunr/lunr.min.js?1674913745" defer></script>
|
||||
<script src="../../js/lunr/lunr.stemmer.support.min.js?1674913745" defer></script>
|
||||
<script src="../../js/lunr/lunr.multi.min.js?1674913745" defer></script>
|
||||
<script src="../../js/lunr/lunr.en.min.js?1674913745" defer></script>
|
||||
<script src="../../js/search.js?1674913745" defer></script>
|
||||
</div>
|
||||
<div id="content-wrapper" class="highlightable">
|
||||
<ul class="topics collapsible-menu">
|
||||
|
|
@ -320,6 +320,8 @@
|
|||
<li data-nav-id="/shortcodes/swagger/index.html" class="dd-item"><a href="../../shortcodes/swagger/index.html">Swagger<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/shortcodes/tabs/index.html" class="dd-item"><a href="../../shortcodes/tabs/index.html">Tabs<i class="fas fa-check read-icon"></i></a></li></ul></li>
|
||||
<li data-nav-id="/dev/index.html" class="dd-item parent"><input type="checkbox" id="section-ad8629dc9507cd96f47ff7ebebbc5d81" aria-controls="subsections-ad8629dc9507cd96f47ff7ebebbc5d81" class="toggle" checked><label class="a11y-only toggle" for="section-ad8629dc9507cd96f47ff7ebebbc5d81" >Submenu Development</label><a href="../../dev/index.html"><b style="display: inline-block; font-weight: 200; padding-left: .3rem; text-align: left; width: 1.1rem;">4.</b> Development<i class="fas fa-check read-icon"></i></a><ul id="subsections-ad8629dc9507cd96f47ff7ebebbc5d81">
|
||||
<li data-nav-id="/dev/contributing/index.html" class="dd-item"><a href="../../dev/contributing/index.html">Contributing<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/dev/maintaining/index.html" class="dd-item"><a href="../../dev/maintaining/index.html">Issue and Release Management<i class="fas fa-check read-icon"></i></a></li>
|
||||
<li data-nav-id="/dev/screenshots/index.html" class="dd-item active"><a href="../../dev/screenshots/index.html">Screenshots<i class="fas fa-check read-icon"></i></a></li></ul></li>
|
||||
</ul>
|
||||
<div id="shortcuts">
|
||||
|
|
@ -393,13 +395,13 @@
|
|||
<a class="github-button" href="https://github.com/McShelby/hugo-theme-relearn" data-icon="octicon-star" data-show-count="true" aria-label="Star McShelby/hugo-theme-relearn on GitHub">Star</a>
|
||||
<a class="github-button" href="https://github.com/McShelby/hugo-theme-relearn/fork" data-icon="octicon-repo-forked" data-show-count="true" aria-label="Fork McShelby/hugo-theme-relearn on GitHub">Fork</a>
|
||||
<p>Built with <a href="https://github.com/McShelby/hugo-theme-relearn" title="love"><i class="fas fa-heart"></i></a> by <a href="https://gohugo.io/">Hugo</a></p>
|
||||
<script async src="../../js/buttons.js?1674903571"></script>
|
||||
<script async src="../../js/buttons.js?1674913745"></script>
|
||||
</div>
|
||||
</div>
|
||||
</aside>
|
||||
<script src="../../js/clipboard.min.js?1674903571" defer></script>
|
||||
<script src="../../js/perfect-scrollbar.min.js?1674903571" defer></script>
|
||||
<script src="../../js/featherlight.min.js?1674903571" defer></script>
|
||||
<script src="../../js/theme.js?1674903571" defer></script>
|
||||
<script src="../../js/clipboard.min.js?1674913745" defer></script>
|
||||
<script src="../../js/perfect-scrollbar.min.js?1674913745" defer></script>
|
||||
<script src="../../js/featherlight.min.js?1674913745" defer></script>
|
||||
<script src="../../js/theme.js?1674913745" defer></script>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -12,22 +12,22 @@
|
|||
<link href="https://McShelby.github.io/hugo-theme-relearn/dev/screenshots/index.html" rel="alternate" hreflang="x-default">
|
||||
<link href="https://McShelby.github.io/hugo-theme-relearn/dev/screenshots/index.html" rel="alternate" hreflang="en">
|
||||
<link href="https://McShelby.github.io/hugo-theme-relearn/pir/dev/screenshots/index.html" rel="alternate" hreflang="pir">
|
||||
<link href="../../images/logo.svg?1674903570" rel="icon" type="image/svg+xml">
|
||||
<link href="../../images/logo.svg?1674913744" rel="icon" type="image/svg+xml">
|
||||
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
|
||||
<link href="../../css/fontawesome-all.min.css?1674903572" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fontawesome-all.min.css?1674903572" rel="stylesheet"></noscript>
|
||||
<link href="../../css/featherlight.min.css?1674903572" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/featherlight.min.css?1674903572" rel="stylesheet"></noscript>
|
||||
<link href="../../css/auto-complete.css?1674903572" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/auto-complete.css?1674903572" rel="stylesheet"></noscript>
|
||||
<link href="../../css/perfect-scrollbar.min.css?1674903572" rel="stylesheet">
|
||||
<link href="../../css/nucleus.css?1674903572" rel="stylesheet">
|
||||
<link href="../../css/fonts.css?1674903572" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fonts.css?1674903572" rel="stylesheet"></noscript>
|
||||
<link href="../../css/theme.css?1674903572" rel="stylesheet">
|
||||
<link href="../../css/theme-relearn-light.css?1674903572" rel="stylesheet" id="variant-style">
|
||||
<link href="../../css/ie.css?1674903572" rel="stylesheet">
|
||||
<link href="../../css/variant.css?1674903572" rel="stylesheet">
|
||||
<link href="../../css/print.css?1674903572" rel="stylesheet" media="print">
|
||||
<link href="../../css/format-print.css?1674903572" rel="stylesheet">
|
||||
<script src="../../js/url.js?1674903572"></script>
|
||||
<script src="../../js/variant.js?1674903572"></script>
|
||||
<link href="../../css/fontawesome-all.min.css?1674913745" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fontawesome-all.min.css?1674913745" rel="stylesheet"></noscript>
|
||||
<link href="../../css/featherlight.min.css?1674913745" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/featherlight.min.css?1674913745" rel="stylesheet"></noscript>
|
||||
<link href="../../css/auto-complete.css?1674913745" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/auto-complete.css?1674913745" rel="stylesheet"></noscript>
|
||||
<link href="../../css/perfect-scrollbar.min.css?1674913745" rel="stylesheet">
|
||||
<link href="../../css/nucleus.css?1674913745" rel="stylesheet">
|
||||
<link href="../../css/fonts.css?1674913745" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fonts.css?1674913745" rel="stylesheet"></noscript>
|
||||
<link href="../../css/theme.css?1674913745" rel="stylesheet">
|
||||
<link href="../../css/theme-relearn-light.css?1674913745" rel="stylesheet" id="variant-style">
|
||||
<link href="../../css/ie.css?1674913745" rel="stylesheet">
|
||||
<link href="../../css/variant.css?1674913745" rel="stylesheet">
|
||||
<link href="../../css/print.css?1674913745" rel="stylesheet" media="print">
|
||||
<link href="../../css/format-print.css?1674913745" rel="stylesheet">
|
||||
<script src="../../js/url.js?1674913745"></script>
|
||||
<script src="../../js/variant.js?1674913745"></script>
|
||||
<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
|
||||
|
|
@ -45,7 +45,7 @@
|
|||
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
|
||||
window.variants && variants.init( [ 'relearn-light', 'relearn-dark', 'learn', 'neon', 'blue', 'green', 'red' ] );
|
||||
</script>
|
||||
<script src="../../js/jquery.min.js?1674903572" defer></script>
|
||||
<script src="../../js/jquery.min.js?1674913745" defer></script>
|
||||
<style>
|
||||
#body img.bg-white {
|
||||
background-color: white;
|
||||
|
|
@ -162,9 +162,9 @@
|
|||
</div>
|
||||
</main>
|
||||
</div>
|
||||
<script src="../../js/clipboard.min.js?1674903572" defer></script>
|
||||
<script src="../../js/perfect-scrollbar.min.js?1674903572" defer></script>
|
||||
<script src="../../js/featherlight.min.js?1674903572" defer></script>
|
||||
<script src="../../js/theme.js?1674903572" defer></script>
|
||||
<script src="../../js/clipboard.min.js?1674913745" defer></script>
|
||||
<script src="../../js/perfect-scrollbar.min.js?1674913745" defer></script>
|
||||
<script src="../../js/featherlight.min.js?1674913745" defer></script>
|
||||
<script src="../../js/theme.js?1674913745" defer></script>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue