mirror of
https://github.com/vacp2p/rfc.git
synced 2025-02-13 15:37:55 +00:00
599 lines
11 KiB
HTML
599 lines
11 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en" dir="ltr">
|
|
|
|
<head>
|
|
<meta name="generator" content="Hugo 0.80.0" />
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="description" content="Step 1. Install Hugo # Go to Hugo releases and download the appropriate version for your OS and architecture.
|
|
Save it somewhere specific as we will be using it in the next step.
|
|
More complete instructions are available at Install Hugo
|
|
Step 2. Build the Docs # Hugo has its own example site which happens to also be the documentation site you are reading right now.
|
|
Follow the following steps:">
|
|
<meta name="theme-color" content="#FFFFFF"><meta property="og:title" content="Getting Started with Hugo" />
|
|
<meta property="og:description" content="Step 1. Install Hugo # Go to Hugo releases and download the appropriate version for your OS and architecture.
|
|
Save it somewhere specific as we will be using it in the next step.
|
|
More complete instructions are available at Install Hugo
|
|
Step 2. Build the Docs # Hugo has its own example site which happens to also be the documentation site you are reading right now.
|
|
Follow the following steps:" />
|
|
<meta property="og:type" content="article" />
|
|
<meta property="og:url" content="http://example.org/posts/hugoisforlovers/" />
|
|
<meta property="article:published_time" content="2014-04-02T00:00:00+00:00" />
|
|
<meta property="article:modified_time" content="2014-04-02T00:00:00+00:00" />
|
|
<title>Getting Started with Hugo | My New Hugo Site</title>
|
|
<link rel="manifest" href="/manifest.json">
|
|
<link rel="icon" href="/favicon.png" type="image/x-icon">
|
|
<link rel="stylesheet" href="/book.min.6c7c6446dfdee7c8c933e9bbc6e80ee3ed6c913b2a59519f2092c3c6a9d63e55.css" integrity="sha256-bHxkRt/e58jJM+m7xugO4+1skTsqWVGfIJLDxqnWPlU=">
|
|
<script defer src="/en.search.min.b058edf587cc787855b3d071254fe14f8dde3f72958d02e619e4aa992f47ef07.js" integrity="sha256-sFjt9YfMeHhVs9BxJU/hT43eP3KVjQLmGeSqmS9H7wc="></script>
|
|
<!--
|
|
Made with Book Theme
|
|
https://github.com/alex-shpak/hugo-book
|
|
-->
|
|
|
|
|
|
</head>
|
|
|
|
<body dir="ltr">
|
|
<input type="checkbox" class="hidden toggle" id="menu-control" />
|
|
<input type="checkbox" class="hidden toggle" id="toc-control" />
|
|
<main class="container flex">
|
|
<aside class="book-menu">
|
|
<div class="book-menu-content">
|
|
|
|
<nav>
|
|
<h2 class="book-brand">
|
|
<a href="/"><span>My New Hugo Site</span>
|
|
</a>
|
|
</h2>
|
|
|
|
|
|
<div class="book-search">
|
|
<input type="text" id="book-search-input" placeholder="Search" aria-label="Search" maxlength="64" data-hotkeys="s/" />
|
|
<div class="book-search-spinner hidden"></div>
|
|
<ul id="book-search-results"></ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li class="book-section-flat" >
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://example.org/docs/example/" class="">Example Site</a>
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://example.org/docs/example/table-of-contents/" class="">Table of Contents</a>
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://example.org/docs/example/table-of-contents/with-toc/" class="">With ToC</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://example.org/docs/example/table-of-contents/without-toc/" class="">Without ToC</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
|
|
<input type="checkbox" id="section-4e46b01272d410b3a99461d79326ddf4" class="toggle" />
|
|
<label for="section-4e46b01272d410b3a99461d79326ddf4" class="flex justify-between">
|
|
<a class="">Collapsed</a>
|
|
<span>▾</span>
|
|
</label>
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://example.org/docs/example/collapsed/3rd-level/" class="">3rd Level</a>
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://example.org/docs/example/collapsed/3rd-level/4th-level/" class="">4th Level</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li class="book-section-flat" >
|
|
|
|
|
|
|
|
|
|
|
|
<span>Shortcodes</span>
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://example.org/docs/shortcodes/buttons/" class="">Buttons</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://example.org/docs/shortcodes/columns/" class="">Columns</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://example.org/docs/shortcodes/details/" class="">Details</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://example.org/docs/shortcodes/expand/" class="">Expand</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://example.org/docs/shortcodes/hints/" class="">Hints</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://example.org/docs/shortcodes/katex/" class="">Katex</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://example.org/docs/shortcodes/mermaid/" class="">Mermaid</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
|
|
<input type="checkbox" id="section-d3fc1bf6d66cd84b896a0af9f40cb1d5" class="toggle" />
|
|
<label for="section-d3fc1bf6d66cd84b896a0af9f40cb1d5" class="flex justify-between">
|
|
<a href="http://example.org/docs/shortcodes/section/" class="">Section</a>
|
|
<span>▾</span>
|
|
</label>
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://example.org/docs/shortcodes/section/page1/" class="">Page1</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://example.org/docs/shortcodes/section/page2/" class="">Page2</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://example.org/docs/shortcodes/tabs/" class="">Tabs</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
<li>
|
|
<a href="/posts/" >
|
|
Blog
|
|
</a>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</nav>
|
|
|
|
|
|
|
|
|
|
<script>(function(){var menu=document.querySelector("aside.book-menu nav");addEventListener("beforeunload",function(event){localStorage.setItem("menu.scrollTop",menu.scrollTop);});menu.scrollTop=localStorage.getItem("menu.scrollTop");})();</script>
|
|
|
|
|
|
|
|
</div>
|
|
</aside>
|
|
|
|
<div class="book-page">
|
|
<header class="book-header">
|
|
|
|
<div class="flex align-center justify-between">
|
|
<label for="menu-control">
|
|
<img src="/svg/menu.svg" class="book-icon" alt="Menu" />
|
|
</label>
|
|
|
|
<strong>Getting Started with Hugo</strong>
|
|
|
|
<label for="toc-control">
|
|
|
|
<img src="/svg/toc.svg" class="book-icon" alt="Table of Contents" />
|
|
|
|
</label>
|
|
</div>
|
|
|
|
|
|
|
|
<aside class="hidden clearfix">
|
|
|
|
|
|
<nav id="TableOfContents">
|
|
<ul>
|
|
<li><a href="#step-1-install-hugo">Step 1. Install Hugo</a></li>
|
|
<li><a href="#step-2-build-the-docs">Step 2. Build the Docs</a></li>
|
|
<li><a href="#step-3-change-the-docs-site">Step 3. Change the docs site</a></li>
|
|
<li><a href="#step-4-have-fun">Step 4. Have fun</a></li>
|
|
</ul>
|
|
</nav>
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</header>
|
|
|
|
|
|
|
|
<article class="markdown">
|
|
<h1>
|
|
<a href="/posts/hugoisforlovers/">Getting Started with Hugo</a>
|
|
</h1>
|
|
|
|
<h5>April 2, 2014</h5>
|
|
|
|
|
|
|
|
|
|
<div>
|
|
|
|
<a href="/categories/development/">Development</a>,
|
|
<a href="/categories/golang/">golang</a>
|
|
</div>
|
|
|
|
|
|
|
|
<div>
|
|
|
|
<a href="/tags/go/">go</a>,
|
|
<a href="/tags/golang/">golang</a>,
|
|
<a href="/tags/hugo/">hugo</a>,
|
|
<a href="/tags/development/">development</a>
|
|
</div>
|
|
|
|
|
|
|
|
<p><h2 id="step-1-install-hugo">
|
|
Step 1. Install Hugo
|
|
<a class="anchor" href="#step-1-install-hugo">#</a>
|
|
</h2>
|
|
<p>Go to <a href="https://github.com/spf13/hugo/releases">Hugo releases</a> and download the
|
|
appropriate version for your OS and architecture.</p>
|
|
<p>Save it somewhere specific as we will be using it in the next step.</p>
|
|
<p>More complete instructions are available at <a href="https://gohugo.io/getting-started/installing/">Install Hugo</a></p>
|
|
<h2 id="step-2-build-the-docs">
|
|
Step 2. Build the Docs
|
|
<a class="anchor" href="#step-2-build-the-docs">#</a>
|
|
</h2>
|
|
<p>Hugo has its own example site which happens to also be the documentation site
|
|
you are reading right now.</p>
|
|
<p>Follow the following steps:</p>
|
|
<ol>
|
|
<li>Clone the <a href="http://github.com/spf13/hugo">Hugo repository</a></li>
|
|
<li>Go into the repo</li>
|
|
<li>Run hugo in server mode and build the docs</li>
|
|
<li>Open your browser to http://localhost:1313</li>
|
|
</ol>
|
|
<p>Corresponding pseudo commands:</p>
|
|
<pre><code>git clone https://github.com/spf13/hugo
|
|
cd hugo
|
|
/path/to/where/you/installed/hugo server --source=./docs
|
|
> 29 pages created
|
|
> 0 tags index created
|
|
> in 27 ms
|
|
> Web Server is available at http://localhost:1313
|
|
> Press ctrl+c to stop
|
|
</code></pre>
|
|
<p>Once you’ve gotten here, follow along the rest of this page on your local build.</p>
|
|
<h2 id="step-3-change-the-docs-site">
|
|
Step 3. Change the docs site
|
|
<a class="anchor" href="#step-3-change-the-docs-site">#</a>
|
|
</h2>
|
|
<p>Stop the Hugo process by hitting Ctrl+C.</p>
|
|
<p>Now we are going to run hugo again, but this time with hugo in watch mode.</p>
|
|
<pre><code>/path/to/hugo/from/step/1/hugo server --source=./docs --watch
|
|
> 29 pages created
|
|
> 0 tags index created
|
|
> in 27 ms
|
|
> Web Server is available at http://localhost:1313
|
|
> Watching for changes in /Users/spf13/Code/hugo/docs/content
|
|
> Press ctrl+c to stop
|
|
</code></pre>
|
|
<p>Open your <a href="http://vim.spf13.com">favorite editor</a> and change one of the source
|
|
content pages. How about changing this very file to <em>fix the typo</em>. How about changing this very file to <em>fix the typo</em>.</p>
|
|
<p>Content files are found in <code>docs/content/</code>. Unless otherwise specified, files
|
|
are located at the same relative location as the url, in our case
|
|
<code>docs/content/overview/quickstart.md</code>.</p>
|
|
<p>Change and save this file.. Notice what happened in your terminal.</p>
|
|
<pre><code>> Change detected, rebuilding site
|
|
|
|
> 29 pages created
|
|
> 0 tags index created
|
|
> in 26 ms
|
|
</code></pre>
|
|
<p>Refresh the browser and observe that the typo is now fixed.</p>
|
|
<p>Notice how quick that was. Try to refresh the site before it’s finished building. I double dare you.
|
|
Having nearly instant feedback enables you to have your creativity flow without waiting for long builds.</p>
|
|
<h2 id="step-4-have-fun">
|
|
Step 4. Have fun
|
|
<a class="anchor" href="#step-4-have-fun">#</a>
|
|
</h2>
|
|
<p>The best way to learn something is to play with it.</p>
|
|
</p>
|
|
</article>
|
|
|
|
|
|
|
|
<footer class="book-footer">
|
|
|
|
<div class="flex flex-wrap justify-between">
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</footer>
|
|
|
|
|
|
|
|
<div class="book-comments">
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<label for="menu-control" class="hidden book-menu-overlay"></label>
|
|
</div>
|
|
|
|
|
|
<aside class="book-toc">
|
|
<div class="book-toc-content">
|
|
|
|
|
|
<nav id="TableOfContents">
|
|
<ul>
|
|
<li><a href="#step-1-install-hugo">Step 1. Install Hugo</a></li>
|
|
<li><a href="#step-2-build-the-docs">Step 2. Build the Docs</a></li>
|
|
<li><a href="#step-3-change-the-docs-site">Step 3. Change the docs site</a></li>
|
|
<li><a href="#step-4-have-fun">Step 4. Have fun</a></li>
|
|
</ul>
|
|
</nav>
|
|
|
|
|
|
|
|
</div>
|
|
</aside>
|
|
|
|
</main>
|
|
|
|
|
|
</body>
|
|
|
|
</html>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|