mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-23 07:47:54 +00:00
530 lines
32 KiB
HTML
530 lines
32 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en" dir="ltr" itemscope itemtype="http://schema.org/Article">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0">
|
|
<meta name="generator" content="Hugo 0.134.2">
|
|
<meta name="generator" content="Relearn 6.3.0+tip">
|
|
<meta name="robots" content="noindex, nofollow, noarchive, noimageindex">
|
|
<meta name="description" content="This chapter contains information only needed for development and maintaining the theme.">
|
|
<meta name="author" content="Sören Weber">
|
|
<meta name="twitter:card" content="summary_large_image">
|
|
<meta name="twitter:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
|
|
<meta name="twitter:title" content="Development :: Hugo Relearn Theme">
|
|
<meta name="twitter:description" content="This chapter contains information only needed for development and maintaining the theme.">
|
|
<meta property="og:url" content="https://mcshelby.github.io/hugo-theme-relearn/dev/index.html">
|
|
<meta property="og:site_name" content="Hugo Relearn Theme">
|
|
<meta property="og:title" content="Development :: Hugo Relearn Theme">
|
|
<meta property="og:description" content="This chapter contains information only needed for development and maintaining the theme.">
|
|
<meta property="og:locale" content="en">
|
|
<meta property="og:type" content="website">
|
|
<meta property="og:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
|
|
<meta itemprop="name" content="Development :: Hugo Relearn Theme">
|
|
<meta itemprop="description" content="This chapter contains information only needed for development and maintaining the theme.">
|
|
<meta itemprop="wordCount" content="32">
|
|
<meta itemprop="image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
|
|
<title>Development :: Hugo Relearn Theme</title>
|
|
<link href="https://mcshelby.github.io/hugo-theme-relearn/dev/index.html" rel="alternate" hreflang="x-default">
|
|
<link href="https://mcshelby.github.io/hugo-theme-relearn/dev/index.html" rel="alternate" hreflang="en">
|
|
<link href="https://mcshelby.github.io/hugo-theme-relearn/pir/dev/index.html" rel="alternate" hreflang="art-x-pir">
|
|
<link href="/hugo-theme-relearn/images/logo.svg?1726132639" rel="icon" type="image/svg+xml">
|
|
<link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1726132639" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1726132639" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/nucleus.css?1726132639" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/auto-complete.css?1726132639" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/auto-complete.css?1726132639" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/perfect-scrollbar.min.css?1726132639" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/fonts.css?1726132639" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fonts.css?1726132639" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/theme.css?1726132639" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/theme-relearn-auto.css?1726132639" rel="stylesheet" id="R-variant-style">
|
|
<link href="/hugo-theme-relearn/css/chroma-relearn-auto.css?1726132639" rel="stylesheet" id="R-variant-chroma-style">
|
|
<link href="/hugo-theme-relearn/css/variant.css?1726132639" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/print.css?1726132639" rel="stylesheet" media="print">
|
|
<link href="/hugo-theme-relearn/css/format-print.css?1726132639" rel="stylesheet">
|
|
<script src="/hugo-theme-relearn/js/variant.js?1726132639"></script>
|
|
<script>
|
|
window.relearn = window.relearn || {};
|
|
window.relearn.relBasePath='..';
|
|
window.relearn.relBaseUri='..\/..';
|
|
window.relearn.absBaseUri='https:\/\/mcshelby.github.io\/hugo-theme-relearn';
|
|
window.relearn.disableAnchorCopy=false;
|
|
window.relearn.disableAnchorScrolling=false;
|
|
window.index_js_url="/hugo-theme-relearn/index.search.js?1726132639";
|
|
// variant stuff
|
|
window.variants && variants.init( [ 'relearn-auto', 'relearn-light', 'relearn-dark', 'relearn-bright', 'zen-auto', 'zen-light', 'zen-dark', 'retro-auto', 'neon', 'learn', 'blue', 'green', 'red' ] );
|
|
// translations
|
|
window.T_Copy_to_clipboard = `Copy to clipboard`;
|
|
window.T_Copied_to_clipboard = `Copied to clipboard!`;
|
|
window.T_Copy_link_to_clipboard = `Copy link to clipboard`;
|
|
window.T_Link_copied_to_clipboard = `Copied link to clipboard!`;
|
|
window.T_Reset_view = `Reset view`;
|
|
window.T_View_reset = `View reset!`;
|
|
window.T_No_results_found = `No results found for "{0}"`;
|
|
window.T_N_results_found = `{1} results found for "{0}"`;
|
|
</script>
|
|
<style>
|
|
#R-body img.bg-white {
|
|
background-color: white;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body class="mobile-support print disableInlineCopyToClipboard" data-url="/hugo-theme-relearn/dev/index.html">
|
|
<div id="R-body" class="default-animation">
|
|
<div id="R-body-overlay"></div>
|
|
<nav id="R-topbar">
|
|
<div class="topbar-wrapper">
|
|
<div class="topbar-sidebar-divider"></div>
|
|
<div class="topbar-area topbar-area-start" data-area="start">
|
|
<div class="topbar-button topbar-button-sidebar" data-content-empty="disable" data-width-s="show" data-width-m="hide" data-width-l="hide"><button class="topbar-control" onclick="toggleNav()" type="button" title="Menu (CTRL+ALT+n)"><i class="fa-fw fas fa-bars"></i></button>
|
|
</div>
|
|
</div>
|
|
<ol class="topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype="http://schema.org/BreadcrumbList"><li
|
|
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Development</span><meta itemprop="position" content="1"></li>
|
|
</ol>
|
|
<div class="topbar-area topbar-area-end" data-area="end">
|
|
<div class="topbar-button topbar-button-prev" data-content-empty="disable" data-width-s="show" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/shortcodes/tabs/index.html" title="Tabs (🡐)"><i class="fa-fw fas fa-chevron-left"></i></a>
|
|
</div>
|
|
<div class="topbar-button topbar-button-next" data-content-empty="disable" data-width-s="show" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/dev/contributing/index.html" title="Contributing (🡒)"><i class="fa-fw fas fa-chevron-right"></i></a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
<div id="R-main-overlay"></div>
|
|
<main id="R-body-inner" class="highlightable chapter narrow" tabindex="-1">
|
|
<div class="flex-block-wrapper">
|
|
<article class="chapter">
|
|
<header class="headline">
|
|
</header>
|
|
<div class="article-subheading">Chapter 4</div>
|
|
|
|
<h1 id="development">Development</h1>
|
|
|
|
<p>This chapter contains information only needed for development and maintaining the theme.</p>
|
|
<div class="children children-h2 children-sort-">
|
|
<h2><a href="/hugo-theme-relearn/dev/contributing/index.html">Contributing</a></h2><p>What to know if you want to contribute</p>
|
|
<h2><a href="/hugo-theme-relearn/dev/maintaining/index.html">Maintaining</a></h2><p>What to know as a maintainer</p>
|
|
<h2><a href="/hugo-theme-relearn/dev/screenshots/index.html">Screenshots</a></h2><p>Recipe to create various documentation screenshots</p>
|
|
</div>
|
|
|
|
<footer class="footline">
|
|
</footer>
|
|
</article>
|
|
|
|
<section>
|
|
<h1 class="a11y-only">Subsections of Development</h1>
|
|
<article class="default">
|
|
<header class="headline">
|
|
</header>
|
|
|
|
<h1 id="contributing">Contributing</h1>
|
|
|
|
<h2 id="code-quality">Code Quality</h2>
|
|
<p>A new release can happen at any time from the <code>main</code> branch of the <a href="https://github.com/McShelby/hugo-theme-relearn" rel="external" target="_self">GitHub project</a> without further acknowledgment. This makes it necessary that, every pushed set of changesets into the <code>main</code> branch <strong>must</strong> be self-contained and correct, resulting in a releasable version.</p>
|
|
<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="/hugo-theme-relearn/basics/migration/index.html">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>
|
|
<h2 id="conventional-commits">Conventional Commits</h2>
|
|
<p>Write commit messages in the <a href="https://www.conventionalcommits.org/en/v1.0.0/" rel="external" target="_self">conventional commit</a> format.</p>
|
|
<p>Following is an inpomplete list of some of the used conventional commit types. Be creative.</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th style="text-align: left">Common</th>
|
|
<th style="text-align: left">Feature</th>
|
|
<th style="text-align: left">Structure</th>
|
|
<th style="text-align: left">Shortcodes</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="text-align: left">build</td>
|
|
<td style="text-align: left">a11y</td>
|
|
<td style="text-align: left">favicon</td>
|
|
<td style="text-align: left">attachments</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left">browser</td>
|
|
<td style="text-align: left">archetypes</td>
|
|
<td style="text-align: left">search</td>
|
|
<td style="text-align: left">badge</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left">chore</td>
|
|
<td style="text-align: left">alias</td>
|
|
<td style="text-align: left">menu</td>
|
|
<td style="text-align: left">button</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left">docs</td>
|
|
<td style="text-align: left">generator</td>
|
|
<td style="text-align: left">history</td>
|
|
<td style="text-align: left">children</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left">shortcodes</td>
|
|
<td style="text-align: left">i18n</td>
|
|
<td style="text-align: left">scrollbar</td>
|
|
<td style="text-align: left">expand</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left">theme</td>
|
|
<td style="text-align: left">mobile</td>
|
|
<td style="text-align: left">nav</td>
|
|
<td style="text-align: left">icon</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left">print</td>
|
|
<td style="text-align: left">toc</td>
|
|
<td style="text-align: left">include</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left">rss</td>
|
|
<td style="text-align: left">clipboard</td>
|
|
<td style="text-align: left">math</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left">variant</td>
|
|
<td style="text-align: left">syntaxhighlight</td>
|
|
<td style="text-align: left">mermaid</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left">boxes</td>
|
|
<td style="text-align: left">notice</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left">openapi</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left">piratify</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left">siteparam</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left"></td>
|
|
<td style="text-align: left">tabs</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<footer class="footline">
|
|
</footer>
|
|
</article>
|
|
|
|
<article class="default">
|
|
<header class="headline">
|
|
</header>
|
|
|
|
<h1 id="maintaining">Maintaining</h1>
|
|
|
|
<h2 id="semver">Semver</h2>
|
|
<p>This project tries to follow the <a href="https://semver.org/" rel="external" target="_self">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="/hugo-theme-relearn/basics/migration/index.html">What’s new</a> page causes a new major release number.</p>
|
|
<p>All other entries on the <a href="/hugo-theme-relearn/basics/migration/index.html">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 bugfixes only, are only increasing the patch release number. Those releases don’t result in announcements on the <a href="/hugo-theme-relearn/basics/migration/index.html">What’s new</a> page.</p>
|
|
<p>Entries on the <a href="/hugo-theme-relearn/basics/migration/index.html">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="/hugo-theme-relearn/dev/maintaining/index.html#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>
|
|
<p>A once released ticket is not allowed to be reopened and rereleased in a different milestone. This would cause the changelog to be changed even for the milestone the issue was previously released in. Instead write a new ticket.</p>
|
|
<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 style="text-align: left">Label</th>
|
|
<th style="text-align: left">Description</th>
|
|
<th style="text-align: left">Changelog section</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #5498d8;">documentation</span></span></td>
|
|
<td style="text-align: left">Improvements or additions to documentation</td>
|
|
<td style="text-align: left">-</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #99d856;">discussion</span></span></td>
|
|
<td style="text-align: left">This issue was converted to a discussion</td>
|
|
<td style="text-align: left">-</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #d8d104;">task</span></span></td>
|
|
<td style="text-align: left">Maintenance work</td>
|
|
<td style="text-align: left">Maintenance</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #d8ae04;">feature</span></span></td>
|
|
<td style="text-align: left">New feature or request</td>
|
|
<td style="text-align: left">Features</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #d88704;">bug</span></span></td>
|
|
<td style="text-align: left">Something isn’t working</td>
|
|
<td style="text-align: left">Fixes</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="impact">Impact</h3>
|
|
<p>If the issue would cause a new main release due to <a href="/hugo-theme-relearn/dev/maintaining/index.html#semver">semver semantics</a> it needs one of the according labels and the matching badge on the <a href="/hugo-theme-relearn/basics/migration/index.html">What’s new</a> page.</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th style="text-align: left">Label</th>
|
|
<th style="text-align: left">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #d73a4a;">change</span></span></td>
|
|
<td style="text-align: left">Introduces changes with existing installations</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #d73a4a;">breaking</span></span></td>
|
|
<td style="text-align: left">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 style="text-align: left">Label</th>
|
|
<th style="text-align: left">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #9fa2a5;">duplicate</span></span></td>
|
|
<td style="text-align: left">This issue or pull request already exists</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #9fa2a5;">invalid</span></span></td>
|
|
<td style="text-align: left">This doesn’t seem right</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #9fa2a5;">support</span></span></td>
|
|
<td style="text-align: left">Request for achieving a special goal</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #9fa2a5;">unresolved</span></span></td>
|
|
<td style="text-align: left">No progress on this issue</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #9fa2a5;">update</span></span></td>
|
|
<td style="text-align: left">A change in behavior after updat</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #9fa2a5;">wontchange</span></span></td>
|
|
<td style="text-align: left">This will not be worked on</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="halt">Halt</h3>
|
|
<p>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 style="text-align: left">Label</th>
|
|
<th style="text-align: left">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #998f6b;">blocked</span></span></td>
|
|
<td style="text-align: left">Depends on other issue to be fixed first</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #998f6b;">idea</span></span></td>
|
|
<td style="text-align: left">A valuable idea that’s currently not worked on</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #998f6b;">undecided</span></span></td>
|
|
<td style="text-align: left">No decision was made yet</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #6426ff;">helpwanted</span></span></td>
|
|
<td style="text-align: left">Great idea, send in a PR</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #6426ff;">needsfeedback</span></span></td>
|
|
<td style="text-align: left">Further 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 style="text-align: left">Label</th>
|
|
<th style="text-align: left">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #e550a7;">asciidoc</span></span></td>
|
|
<td style="text-align: left">This is a topic related to processing of AsciiDoc</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #e550a7;">browser</span></span></td>
|
|
<td style="text-align: left">This is a topic related to the browser but not the theme</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #e550a7;">device</span></span></td>
|
|
<td style="text-align: left">This is a topic related to a certain device</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #e550a7;">hugo</span></span></td>
|
|
<td style="text-align: left">This is a topic related to Hugo itself but not the theme</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #e550a7;">mermaid</span></span></td>
|
|
<td style="text-align: left">This 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 responsibility to check <a href="/hugo-theme-relearn/dev/maintaining/index.html#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>Treat released milestones as immutable. Don’t rerelease an already released milestone. An already released milestone may already been consumed by your users.</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>if it’s a main release, there must be a new <code><major>.<minor></code> at the beginning of the <a href="/hugo-theme-relearn/basics/migration/index.html">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="/hugo-theme-relearn/basics/migration/index.html">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" rel="external" target="_self">History</a> page is updated, including release version, release date and text</li>
|
|
<li>the <a href="https://mcshelby.github.io/hugo-theme-relearn/basics/migration/index.html" rel="external" target="_self">What’s new</a> page is updated, including release version, release date and text</li>
|
|
<li>the version number for the <code><meta generator></code> is updated</li>
|
|
<li>the updated files are committed</li>
|
|
<li>the milestone is closed</li>
|
|
<li>the repository is tagged with the version number (eg. <code>1.2.3</code>), the main version number (eg. <code>1.2.x</code>) and the major version number (eg. <code>1.x</code>)</li>
|
|
<li>a new entry in the <a href="https://github.com/McShelby/hugo-theme-relearn/releases" rel="external" target="_self">GitHub release list</a> with the according changelog will be created</li>
|
|
<li>the <a href="https://mcshelby.github.io/hugo-theme-relearn/index.html" rel="external" target="_self">official documentation</a> is built and deployed</li>
|
|
<li>the version number for the <code><meta generator></code> is updated to a temporary and committed (this helps to determine if users are running directly on the main branch or are using releases)</li>
|
|
<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">
|
|
<header class="headline">
|
|
</header>
|
|
|
|
<h1 id="screenshots">Screenshots</h1>
|
|
|
|
<p>Sometimes screenshots need to be redone. This page explains how to create the different screenshots, tools and settings</p>
|
|
<h2 id="common">Common</h2>
|
|
<p><strong>Creation</strong>:</p>
|
|
<ul>
|
|
<li>Use English translation</li>
|
|
<li>Empty search</li>
|
|
<li>Remove history checkmarks but leave it on the page thats used for the screenshot</li>
|
|
<li>After resize of the page into the required resolution, reload the page to have all scrollbars in default loading position</li>
|
|
</ul>
|
|
<h2 id="demo-screenshot">Demo Screenshot</h2>
|
|
<p><strong>Content</strong>:</p>
|
|
<p>A meaningful full-screen screenshot of an interesting page.</p>
|
|
<p>The content should be:</p>
|
|
<ul>
|
|
<li>timeless: not showing any dates or often edited content</li>
|
|
<li>interesting: show a bunch of interesting elements like headings, code, etc</li>
|
|
<li>balanced: no cluttering with overpresent elements or coloring</li>
|
|
<li>aligned: aligned outlines</li>
|
|
</ul>
|
|
<p><strong>Used by</strong>:</p>
|
|
<ul>
|
|
<li>Hugo Themes info: <a href="https://themes.gohugo.io/themes/hugo-theme-relearn/" rel="external" target="_self">https://themes.gohugo.io/themes/hugo-theme-relearn/</a> <em>1000 x 1500 @ 1</em></li>
|
|
</ul>
|
|
<p><strong>Page URL</strong>: <a href="/hugo-theme-relearn/shortcodes/notice/index.html">Screenshot Link</a></p>
|
|
<p><strong>Creation</strong>:</p>
|
|
<ul>
|
|
<li>save as <code>images/screenshot.png</code></li>
|
|
</ul>
|
|
<p><strong>Remarks</strong>:</p>
|
|
<p>The location is mandatory due to Hugo’s theme site builder.</p>
|
|
<p><strong>Preview</strong> <code>images/screenshot.png</code>:</p>
|
|
<p><a href="#R-image-96a5c0b5419c08b700837bc76d0dcac8" class="lightbox-link"><img alt="Screenshot" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="/hugo-theme-relearn/images/screenshot.png?width=50%25&height=50%25" style=" height: 50%; width: 50%;"></a>
|
|
<a href="javascript:history.back();" class="lightbox-back" id="R-image-96a5c0b5419c08b700837bc76d0dcac8"><img alt="Screenshot" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="/hugo-theme-relearn/images/screenshot.png?width=50%25&height=50%25"></a></p>
|
|
<h2 id="hero-image">Hero Image</h2>
|
|
<p><strong>Content</strong>:</p>
|
|
<p>Show the <a href="/hugo-theme-relearn/dev/screenshots/index.html#demo-screenshot">Demo Screenshot</a> page on different devices and different themes. Composition of the different device screenshots into a template.</p>
|
|
<p>The content should be:</p>
|
|
<ul>
|
|
<li>consistent: always use the same page for all devices</li>
|
|
<li>pleasing: use a delightful background</li>
|
|
</ul>
|
|
<p><strong>Used by</strong>:</p>
|
|
<ul>
|
|
<li>Hugo Themes gallery: <a href="https://themes.gohugo.io/tags/docs/" rel="external" target="_self">https://themes.gohugo.io/tags/docs/</a> <em>900 x 600</em></li>
|
|
<li>Hugo Themes notes: <a href="https://themes.gohugo.io/themes/hugo-theme-relearn/" rel="external" target="_self">https://themes.gohugo.io/themes/hugo-theme-relearn/</a> <em>1280 x 640</em></li>
|
|
<li>GitHub project site: <a href="https://github.com/McShelby/hugo-theme-relearn" rel="external" target="_self">https://github.com/McShelby/hugo-theme-relearn</a> <em>1280 x 640</em></li>
|
|
<li>GitHub social media preview: <a href="https://github.com/McShelby/hugo-theme-relearn/settings" rel="external" target="_self">https://github.com/McShelby/hugo-theme-relearn/settings</a> <em>1280 x 640</em></li>
|
|
</ul>
|
|
<p><strong>Page URL</strong>: <a href="/hugo-theme-relearn/shortcodes/notice/index.html">Hero Image Link</a></p>
|
|
<p><strong>Creation</strong>:</p>
|
|
<ul>
|
|
<li>Template: <a href="http://www.pixeden.com/psd-web-elements/psd-screen-web-showcase" rel="external" target="_self">http://www.pixeden.com/psd-web-elements/psd-screen-web-showcase</a></li>
|
|
<li>Desktop: light theme <em>1440 x 900 @ 1</em></li>
|
|
<li>Tablet: light theme <em>778 x 1038 @ 1</em></li>
|
|
<li>Phone: dark theme <em>450 x 801 @ .666</em></li>
|
|
<li>From original template size resize to <em>2700 x 1800</em> centered, scale to <em>900 x 600</em> and save as <code>images/tn.png</code></li>
|
|
<li>From original template size resize to <em>3000 x 1500</em> offset y: <em>-330</em>, scale to <em>1280 x 640</em> and save as <code>images/hero.png</code></li>
|
|
</ul>
|
|
<p><strong>Remarks</strong>:</p>
|
|
<p>The location of <code>images/tn.png</code> is mandatory due to Hugo’s theme site builder.</p>
|
|
<p><strong>Preview</strong> <code>images/hero.png</code>:</p>
|
|
<p><a href="#R-image-a130c196cbb0ca2aacad233d677b0439" class="lightbox-link"><img alt="Hero" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="/hugo-theme-relearn/images/hero.png?width=50%25&height=50%25" style=" height: 50%; width: 50%;"></a>
|
|
<a href="javascript:history.back();" class="lightbox-back" id="R-image-a130c196cbb0ca2aacad233d677b0439"><img alt="Hero" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="/hugo-theme-relearn/images/hero.png?width=50%25&height=50%25"></a></p>
|
|
<p><strong>Preview</strong> <code>images/tn.png</code>:</p>
|
|
<p><a href="#R-image-1ec6b1138e3fa0ad9473c3e9d4fe34d2" class="lightbox-link"><img alt="tn" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="/hugo-theme-relearn/images/tn.png?width=50%25&height=50%25" style=" height: 50%; width: 50%;"></a>
|
|
<a href="javascript:history.back();" class="lightbox-back" id="R-image-1ec6b1138e3fa0ad9473c3e9d4fe34d2"><img alt="tn" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="/hugo-theme-relearn/images/tn.png?width=50%25&height=50%25"></a></p>
|
|
|
|
<footer class="footline">
|
|
</footer>
|
|
</article>
|
|
|
|
</section>
|
|
</div>
|
|
</main>
|
|
</div>
|
|
<script src="/hugo-theme-relearn/js/clipboard.min.js?1726132639" defer></script>
|
|
<script src="/hugo-theme-relearn/js/perfect-scrollbar.min.js?1726132639" defer></script>
|
|
<script src="/hugo-theme-relearn/js/theme.js?1726132639" defer></script>
|
|
</body>
|
|
</html>
|