mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-10-27 18:53:18 +00:00
185 lines
10 KiB
HTML
185 lines
10 KiB
HTML
<!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.1+tip">
|
|
<meta name="robots" content="noindex, nofollow, noarchive, noimageindex">
|
|
<meta name="description" content="Documentation for Hugo Relearn Theme">
|
|
<meta name="author" content="Sören Weber">
|
|
<title>Development :: 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="pir">
|
|
<link href="../images/logo.svg?1674688162" 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?1674688163" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../css/fontawesome-all.min.css?1674688163" rel="stylesheet"></noscript>
|
|
<link href="../css/featherlight.min.css?1674688163" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../css/featherlight.min.css?1674688163" rel="stylesheet"></noscript>
|
|
<link href="../css/auto-complete.css?1674688163" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../css/auto-complete.css?1674688163" rel="stylesheet"></noscript>
|
|
<link href="../css/perfect-scrollbar.min.css?1674688163" rel="stylesheet">
|
|
<link href="../css/nucleus.css?1674688163" rel="stylesheet">
|
|
<link href="../css/fonts.css?1674688163" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../css/fonts.css?1674688163" rel="stylesheet"></noscript>
|
|
<link href="../css/theme.css?1674688163" rel="stylesheet">
|
|
<link href="../css/theme-relearn-light.css?1674688163" rel="stylesheet" id="variant-style">
|
|
<link href="../css/ie.css?1674688163" rel="stylesheet">
|
|
<link href="../css/variant.css?1674688163" rel="stylesheet">
|
|
<link href="../css/print.css?1674688163" rel="stylesheet" media="print">
|
|
<link href="../css/format-print.css?1674688163" rel="stylesheet">
|
|
<script src="../js/url.js?1674688163"></script>
|
|
<script src="../js/variant.js?1674688163"></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?1674688163" defer></script>
|
|
<style>
|
|
#body img.bg-white {
|
|
background-color: white;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body class="mobile-support print disableInlineCopyToClipboard" data-url="../dev/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"><span itemprop="name">Development</span><meta itemprop="position" content="2"></li>
|
|
</ol>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
<main id="body-inner" class="highlightable chapter narrow" tabindex="-1">
|
|
<div class="flex-block-wrapper">
|
|
<div id="head-tags">
|
|
</div>
|
|
<article class="chapter">
|
|
<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="../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">
|
|
<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>
|
|
<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>
|
|
</ul>
|
|
<h2 id="screenshot">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/" target="_blank">https://themes.gohugo.io/themes/hugo-theme-relearn/</a> <em>1000 x 1500 @ 1</em></li>
|
|
</ul>
|
|
<p><strong>Page URL</strong>: <a href="../shortcodes/include/">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="../images/screenshot.png?classes=shadow&width=100%25&height=100%25" data-featherlight="image">
|
|
<img src="../images/screenshot.png?classes=shadow&width=100%25&height=100%25" alt="Screenshot" class="shadow" style="height: 100%; width: 100%;" loading="lazy">
|
|
</a></p>
|
|
<h2 id="hero-image">Hero Image</h2>
|
|
<p><strong>Content</strong>:</p>
|
|
<p>Show the <a href="#screenshot">screenshot</a> page on different devices and different themes. Composition of different images.</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/" target="_blank">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/" target="_blank">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" target="_blank">https://github.com/McShelby/hugo-theme-relearn</a> <em>1280 x 640</em></li>
|
|
<li>GitHub social media preview: <a href="https://github.com/McShelby/hugo-theme-relearn/settings" target="_blank">https://github.com/McShelby/hugo-theme-relearn/settings</a> <em>1280 x 640</em></li>
|
|
</ul>
|
|
<p><strong>Page URL</strong>: <a href="../shortcodes/include/">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" target="_blank">http://www.pixeden.com/psd-web-elements/psd-screen-web-showcase</a></li>
|
|
<li>Desktop: light theme <em>1440 x 900 @ 1</em></li>
|
|
<li>Tablet: light theme <em>778 x 1038 @ 1</em></li>
|
|
<li>Phone: dark theme <em>450 x 801 @ .666</em></li>
|
|
<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="../images/hero.png?classes=shadow&width=100%25&height=100%25" data-featherlight="image">
|
|
<img src="../images/hero.png?classes=shadow&width=100%25&height=100%25" alt="Hero" class="shadow" style="height: 100%; width: 100%;" loading="lazy">
|
|
</a></p>
|
|
<p><strong>Preview</strong> <code>images/tn.png</code>:</p>
|
|
<p>
|
|
|
|
|
|
<a href="../images/tn.png?classes=shadow&width=100%25&height=100%25" data-featherlight="image">
|
|
<img src="../images/tn.png?classes=shadow&width=100%25&height=100%25" alt="tn" class="shadow" style="height: 100%; width: 100%;" loading="lazy">
|
|
</a></p>
|
|
|
|
<footer class="footline">
|
|
</footer>
|
|
</article>
|
|
|
|
</section> </div>
|
|
</main>
|
|
</div>
|
|
<script src="../js/clipboard.min.js?1674688163" defer></script>
|
|
<script src="../js/perfect-scrollbar.min.js?1674688163" defer></script>
|
|
<script src="../js/featherlight.min.js?1674688163" defer></script>
|
|
<script src="../js/theme.js?1674688163" defer></script>
|
|
</body>
|
|
</html>
|