-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.xml
More file actions
82 lines (82 loc) · 17.2 KB
/
Copy pathindex.xml
File metadata and controls
82 lines (82 loc) · 17.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel>
<title>Homepage on Personal Digital Garden</title>
<link>https://linky-blog.pages.dev/</link>
<description>Recent content in Homepage on Personal Digital Garden</description>
<generator>Hugo</generator>
<language>en-us</language>
<lastBuildDate>Sun, 19 Dec 2021 00:00:00 +0000</lastBuildDate>
<atom:link href="https://linky-blog.pages.dev/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>1. Theme Installation</title>
<link>https://linky-blog.pages.dev/articles/installation/</link>
<pubDate>Sun, 19 Dec 2021 00:00:00 +0000</pubDate>
<guid>https://linky-blog.pages.dev/articles/installation/</guid>
<description><p>Create a new hugo website or open your existing hugo site.</p>
<h4 id="add-the-theme-to-your-hugo-site">Add the theme to your hugo site</h4>
<p>Use as a git submodule:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>git submodule add https://github.com/apvarun/digital-garden-hugo-theme.git themes/digitalgarden
</span></span></code></pre></div><p>Clone the repository (one-off, updating the theme may be harder later):</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>git clone https://github.com/apvarun/digital-garden-hugo-theme.git themes/digitalgarden
</span></span></code></pre></div><h4 id="setup">Setup</h4>
<ol>
<li>Copy <code>package.json</code>, <code>package-lock.json</code> and <code>tailwind.config.js</code> files from the theme/digitalgarden folder to the root folder of your the website</li>
<li>Run <code>npm install</code> to install required packages for theme</li>
<li>Run <code>npm i -g postcss-cli</code> to use PostCSS with Hugo build</li>
<li>Set <code>theme = 'digitalgarden'</code> in config.toml</li>
<li>Run <code>npm run dev</code> to start your local server</li>
</ol>
<p>When deploying to services like Netlify or Vercel, use the following command for building your site:</p></description>
</item>
<item>
<title>2. Structure</title>
<link>https://linky-blog.pages.dev/articles/structure/</link>
<pubDate>Sat, 18 Dec 2021 00:00:00 +0000</pubDate>
<guid>https://linky-blog.pages.dev/articles/structure/</guid>
<description><p>Understand the structure of the theme&rsquo;s setup to create content for your website.</p>
<h4 id="themes-content-structure">Theme&rsquo;s content structure</h4>
<pre tabindex="0"><code>.
├── ...
├── content # Hosts all Markdown content
│ ├── articles # Contains the list of markdown files for notes/posts
│ │ ├── article-1.md
│ │ ├── article-2.md
│ │ └── article-3.md
│ └── portfolio # List of portfolio projects or case studies
│ ├── project-1.md
│ └── project-2.md
├── data # Test files (alternatively `spec` or `tests`)
│ └── stack.json # Data used for rendering the list in Stack page
└── ...
</code></pre><p>Note that articles, portfolio and also stack pages require you to create <code>_index.md</code> inside of it. Refer the <a href="https://github.com/apvarun/digital-garden-hugo-theme/tree/main/exampleSite" target="_blank" rel="noopener" >exampleSite</a> in theme.</p></description>
</item>
<item>
<title>3. Primary Menu</title>
<link>https://linky-blog.pages.dev/articles/primary-menu/</link>
<pubDate>Sat, 18 Dec 2021 00:00:00 +0000</pubDate>
<guid>https://linky-blog.pages.dev/articles/primary-menu/</guid>
<description><p>The sidebar of the theme uses the <code>main</code> menu. Add all the items for your sidebar navigation in this menu.</p>
<p>// config.toml</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-toml" data-lang="toml"><span style="display:flex;"><span>[menu]
</span></span><span style="display:flex;"><span>[[menu.main]]
</span></span><span style="display:flex;"><span> name = <span style="color:#f1fa8c">&#39;Home&#39;</span>
</span></span><span style="display:flex;"><span> url = <span style="color:#f1fa8c">&#39;/&#39;</span>
</span></span><span style="display:flex;"><span> weight = <span style="color:#bd93f9">1</span>
</span></span><span style="display:flex;"><span>[[menu.main]]
</span></span><span style="display:flex;"><span> name = <span style="color:#f1fa8c">&#39;Content&#39;</span>
</span></span><span style="display:flex;"><span> params.header = <span style="color:#ff79c6">true</span>
</span></span><span style="display:flex;"><span> weight = <span style="color:#bd93f9">2</span>
</span></span><span style="display:flex;"><span>[[menu.main]]
</span></span><span style="display:flex;"><span> name = <span style="color:#f1fa8c">&#39;Articles&#39;</span>
</span></span><span style="display:flex;"><span> url = <span style="color:#f1fa8c">&#39;/articles&#39;</span>
</span></span><span style="display:flex;"><span> weight = <span style="color:#bd93f9">3</span>
</span></span></code></pre></div><ul>
<li><code>name</code> → Title of the menu item</li>
<li><code>url</code> → Path to navigate</li>
<li><code>weight</code> → Used to decide the order of menu items</li>
<li><code>params.header</code> → Display menu item as header</li>
</ul>
<p>If the link points to an external website, the external icon is already displayed.</p></description>
</item>
<item>
<title>4. Social Menu</title>
<link>https://linky-blog.pages.dev/articles/social-menu/</link>
<pubDate>Sat, 18 Dec 2021 00:00:00 +0000</pubDate>
<guid>https://linky-blog.pages.dev/articles/social-menu/</guid>
<description><p>The social menu can be used to configure all the social icons in the sidebar. Add links to your social media in the website config to show the icons.</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-toml" data-lang="toml"><span style="display:flex;"><span>[[menu.social]]
</span></span><span style="display:flex;"><span> name = <span style="color:#f1fa8c">&#39;Twitter&#39;</span>
</span></span><span style="display:flex;"><span> url = <span style="color:#f1fa8c">&#39;https://twitter.com&#39;</span>
</span></span><span style="display:flex;"><span> weight = <span style="color:#bd93f9">1</span>
</span></span></code></pre></div><p>The <code>name</code> of the social menu needs to be unique and should be one of the supported values.</p>
<p>Supported values for the social menu item name:</p>
<ul>
<li>Twitter</li>
<li>GitHub</li>
<li>LinkedIn</li>
<li>Instagram</li>
<li>Mastodon</li>
<li>Dribbble</li>
<li>Codepen</li>
<li>Twitch</li>
<li>Email</li>
<li>RSS</li>
</ul>
<p>→ <a href="https://linky-blog.pages.dev/articles/newsletter" >Configure newsletter</a></p></description>
</item>
<item>
<title>5. Newsletter</title>
<link>https://linky-blog.pages.dev/articles/newsletter/</link>
<pubDate>Sat, 18 Dec 2021 00:00:00 +0000</pubDate>
<guid>https://linky-blog.pages.dev/articles/newsletter/</guid>
<description><p>The theme supports a subscription to multiple newsletter providers.</p>
<ul>
<li><strong>Buttondown</strong></li>
<li><strong>Substack</strong></li>
<li><strong>Revue</strong></li>
</ul>
<h2 id="buttondown">Buttondown</h2>
<p>[Params.newsletter.provider] = &ldquo;buttondown&rdquo;</p>
<p>Copy the <code>action</code> url from your buttondown admin dashboard and add it to <strong>[Params.newsletter.path]</strong> in config.toml</p>
<p><img src="https://blog.buttondown.email/img/9.png" alt="Buttondown share form URL"></p>
<h2 id="substack">Substack</h2>
<p>[Params.newsletter.provider] = &ldquo;substack&rdquo;</p>
<p>Setting up substack is the easiest. Just add your substack newsletter URL (applicable for custom domains also) to <strong>[Params.newsletter.path]</strong> in config.toml</p>
<p>Note that since substack doesn&rsquo;t have a native API for subscription. The theme uses the api from substackapi.com which is in no way associated to Substack itself.</p></description>
</item>
<item>
<title>6. Google Analytics</title>
<link>https://linky-blog.pages.dev/articles/google-analytics/</link>
<pubDate>Sat, 18 Dec 2021 00:00:00 +0000</pubDate>
<guid>https://linky-blog.pages.dev/articles/google-analytics/</guid>
<description><p>Digital garden theme utilizes the Hugo&rsquo;s [internal template](internal templates) for Google analytics and so both Google analytics v3 and GA v4 (gtag) are supported.</p>
<p>Add your <strong>UA-PROPERTY_ID</strong> or <strong>G-MEASUREMENT_ID</strong> to config.toml</p>
<h4 id="google-analytics-v3-analyticsjs">Google Analytics v3 (analytics.js)</h4>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-toml" data-lang="toml"><span style="display:flex;"><span>googleAnalytics = <span style="color:#f1fa8c">&#39;UA-PROPERTY_ID&#39;</span>
</span></span></code></pre></div><h4 id="google-analytics-v4-gtagjs">Google Analytics v4 (gtag.js)</h4>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-toml" data-lang="toml"><span style="display:flex;"><span>googleAnalytics = <span style="color:#f1fa8c">&#39;G-MEASUREMENT_ID&#39;</span>
</span></span></code></pre></div><p>→ <a href="https://linky-blog.pages.dev/articles/metatags" >Configure Metatags</a></p></description>
</item>
<item>
<title>7. Metatags</title>
<link>https://linky-blog.pages.dev/articles/metatags/</link>
<pubDate>Sat, 18 Dec 2021 00:00:00 +0000</pubDate>
<guid>https://linky-blog.pages.dev/articles/metatags/</guid>
<description><p>Metatags are used to provide additional information about the page, usually used by search engines and social media websites / apps. It allows to customize your page&rsquo;s title, description, preview image and more.</p>
<h3 id="configure-default-tags">Configure default tags</h3>
<p>// config.toml</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-toml" data-lang="toml"><span style="display:flex;"><span>title = <span style="color:#f1fa8c">&#34;Personal Digital Garden&#34;</span>
</span></span><span style="display:flex;"><span>
</span></span><span style="display:flex;"><span>[Params]
</span></span><span style="display:flex;"><span> description = <span style="color:#f1fa8c">&#34;My Digital Garden on the Internet&#34;</span>
</span></span><span style="display:flex;"><span> images = [<span style="color:#f1fa8c">&#39;/digital-garden-logo.png&#39;</span>]
</span></span></code></pre></div><p>Setting the above values will be used as default for all pages unless its overridden in a specific page&rsquo;s markdown.</p></description>
</item>
<item>
<title>Pastry jelly cookie sugar donut orange</title>
<link>https://linky-blog.pages.dev/portfolio/design1/</link>
<pubDate>Sat, 18 Dec 2021 00:00:00 +0000</pubDate>
<guid>https://linky-blog.pages.dev/portfolio/design1/</guid>
<description><p>Croissant orange croissant dolor orange croissant. Lollipop biscuit donut vanilla sweet croissant. Apple donut candy tiramisu cream jelly. Croissant sweet cookie vanilla tiramisu dolor.</p>
<p>Pastry jelly cookie sugar donut orange. Candy sweet cookie sweet donut marzipan. Vanilla cookie sprinkles pastry orange cookie. Marzipan donut ipsum sugar biscuit vanilla.</p>
<p>Candy cookie muffin pastry lollipop vanilla. Apple orange tiramisu jelly ipsum sugar. Candy cake orange ipsum orange muffin. Sugar pastry orange cream orange pastry.</p></description>
</item>
<item>
<title>Cream sugar apple donut apple croissant</title>
<link>https://linky-blog.pages.dev/portfolio/design2/</link>
<pubDate>Fri, 17 Dec 2021 00:00:00 +0000</pubDate>
<guid>https://linky-blog.pages.dev/portfolio/design2/</guid>
<description><p>Tiramisu sprinkles marzipan lollipop marzipan dolor. Jelly candy marzipan vanilla candy ipsum. Sugar croissant lollipop vanilla cream marzipan. Sprinkles croissant cream dolor jelly marzipan.</p>
<p>Pastry jelly cookie sugar donut orange. Candy sweet cookie sweet donut marzipan. Vanilla cookie sprinkles pastry orange cookie. Marzipan donut ipsum sugar biscuit vanilla.</p>
<p>Candy cookie muffin pastry lollipop vanilla. Apple orange tiramisu jelly ipsum sugar. Candy cake orange ipsum orange muffin. Sugar pastry orange cream orange pastry.</p></description>
</item>
<item>
<title>Apple cream vanilla apple marzipan muffin</title>
<link>https://linky-blog.pages.dev/portfolio/design3/</link>
<pubDate>Thu, 16 Dec 2021 00:00:00 +0000</pubDate>
<guid>https://linky-blog.pages.dev/portfolio/design3/</guid>
<description><p>Tiramisu sprinkles marzipan lollipop marzipan dolor. Jelly candy marzipan vanilla candy ipsum. Sugar croissant lollipop vanilla cream marzipan. Sprinkles croissant cream dolor jelly marzipan.</p>
<p>Pastry jelly cookie sugar donut orange. Candy sweet cookie sweet donut marzipan. Vanilla cookie sprinkles pastry orange cookie. Marzipan donut ipsum sugar biscuit vanilla.</p>
<p>Candy cookie muffin pastry lollipop vanilla. Apple orange tiramisu jelly ipsum sugar. Candy cake orange ipsum orange muffin. Sugar pastry orange cream orange pastry.</p></description>
</item>
</channel>
</rss>