documentation/docs/prologue/quick-start/index.html

<!doctype html><html lang=en-us><head><meta charset=utf-8><meta http-equiv=x-ua-compatible content="ie=edge"><meta name=viewport content="width=device-width,initial-scale=1,shrink-to-fit=no"><link rel=preload as=font href=https://doks.netlify.app/fonts/vendor/jost/jost-v4-latin-regular.woff2 type=font/woff2 crossorigin><link rel=preload as=font href=https://doks.netlify.app/fonts/vendor/jost/jost-v4-latin-700.woff2 type=font/woff2 crossorigin><link rel=stylesheet href=https://doks.netlify.app/main.6d50fb43d6d8e8ef8d65170e04837eb9f84a796b3a015777a1bd8b3de9d36118c16a1775fb9738165186e1ab68414520e828f3848ddd6e35d18dee5a0075e5be.css integrity="sha512-bVD7Q9bY6O+NZRcOBIN+ufhKeWs6AVd3ob2LPenTYRjBahd1+5c4FlGG4atoQUUg6CjzhI3dbjXRje5aAHXlvg==" crossorigin=anonymous><noscript><style>img.lazyload{display:none}</style></noscript><meta name=robots content="index, follow"><meta name=googlebot content="index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1"><meta name=bingbot content="index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1"><title>Quick Start - Doks</title><meta name=description content="One page summary of how to start a new Doks project."><link rel=canonical href=https://doks.netlify.app/docs/prologue/quick-start/><meta name=twitter:card content="summary_large_image"><meta name=twitter:image content="/doks.png"><meta name=twitter:title content="Quick Start"><meta name=twitter:description content="One page summary of how to start a new Doks project."><meta name=twitter:site content="@henkverlinde"><meta name=twitter:creator content="@henkverlinde"><meta property="og:title" content="Quick Start"><meta property="og:description" content="One page summary of how to start a new Doks project."><meta property="og:type" content="article"><meta property="og:url" content="/docs/prologue/quick-start/"><meta property="og:image" content="/doks.png"><meta property="article:published_time" content="2020-11-16T13:59:39+01:00"><meta property="article:modified_time" content="2020-11-16T13:59:39+01:00"><meta property="og:site_name" content="Doks"><meta property="article:publisher" content="https://www.facebook.com/verlinde.henk"><meta property="article:author" content="https://www.facebook.com/verlinde.henk"><meta property="og:locale" content="en_US"><script type=application/ld+json>{"@context":"http://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/doks.netlify.app\/"},{"@type":"ListItem","position":3,"name":"Docs","item":"https:\/\/doks.netlify.app\/\/docs\/"},{"@type":"ListItem","position":4,"name":"Prologue","item":"https:\/\/doks.netlify.app\/\/docs\/prologue\/"},{"@type":"ListItem","position":5,"name":"Quick Start","item":"https:\/\/doks.netlify.app\/\/docs\/prologue\/quick-start\/"}]}</script><meta name=theme-color content="#fff"><link rel=apple-touch-icon sizes=180x180 href=https://doks.netlify.app/apple-touch-icon.png><link rel=icon type=image/png sizes=32x32 href=https://doks.netlify.app/favicon-32x32.png><link rel=icon type=image/png sizes=16x16 href=https://doks.netlify.app/favicon-16x16.png><link rel=manifest href=https://doks.netlify.app/site.webmanifest></head><body class="docs single"><div class="header-bar fixed-top"></div><header class="navbar fixed-top navbar-expand-md navbar-light"><div class=container><input class="menu-btn order-0" type=checkbox id=menu-btn>
<label class="menu-icon d-md-none" for=menu-btn><span class=navicon></span></label><a class="navbar-brand order-1 order-md-0 me-auto" href=https://doks.netlify.app/>Doks</a>
<button id=mode class="btn btn-link order-2 order-md-4" type=button aria-label="Toggle mode">
<span class=toggle-dark><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-moon"><path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"/></svg></span><span class=toggle-light><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-sun"><circle cx="12" cy="12" r="5"/><line x1="12" y1="1" x2="12" y2="3"/><line x1="12" y1="21" x2="12" y2="23"/><line x1="4.22" y1="4.22" x2="5.64" y2="5.64"/><line x1="18.36" y1="18.36" x2="19.78" y2="19.78"/><line x1="1" y1="12" x2="3" y2="12"/><line x1="21" y1="12" x2="23" y2="12"/><line x1="4.22" y1="19.78" x2="5.64" y2="18.36"/><line x1="18.36" y1="5.64" x2="19.78" y2="4.22"/></svg></span></button><ul class="navbar-nav social-nav order-3 order-md-5"><li class=nav-item><a class=nav-link href=https://twitter.com/getdoks><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-twitter"><path d="M23 3a10.9 10.9.0 01-3.14 1.53 4.48 4.48.0 00-7.86 3v1A10.66 10.66.0 013 4s-4 9 5 13a11.64 11.64.0 01-7 2c9 5 20 0 20-11.5a4.5 4.5.0 00-.08-.83A7.72 7.72.0 0023 3z"/></svg><span class="ms-2 visually-hidden">Twitter</span></a></li><li class=nav-item><a class=nav-link href=https://github.com/h-enk/doks><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-github"><path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37.0 00-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44.0 0020 4.77 5.07 5.07.0 0019.91 1S18.73.65 16 2.48a13.38 13.38.0 00-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07.0 005 4.77 5.44 5.44.0 003.5 8.55c0 5.42 3.3 6.61 6.44 7A3.37 3.37.0 009 18.13V22"/></svg><span class="ms-2 visually-hidden">GitHub</span></a></li></ul><div class="collapse navbar-collapse order-4 order-md-1"><ul class="navbar-nav main-nav me-auto order-5 order-md-2"><li class="nav-item active"><a class=nav-link href=https://doks.netlify.app/docs/prologue/introduction/>Docs</a></li><li class=nav-item><a class=nav-link href=https://doks.netlify.app/blog/>Blog</a></li></ul><div class="break order-6 d-md-none"></div><form class="navbar-form flex-grow-1 order-7 order-md-3"><input id=userinput class="form-control is-search" type=search placeholder="Search docs..." aria-label="Search docs..." autocomplete=off><div id=suggestions class="shadow bg-white rounded"></div></form></div></div></header><div class="wrap container" role=document><div class=content><div class="row flex-xl-nowrap"><div class="col-lg-5 col-xl-4 docs-sidebar"><nav class=docs-links aria-label="Main navigation"><h3>Prologue</h3><ul class=list-unstyled><li><a class=docs-link href=https://doks.netlify.app/docs/prologue/introduction/>Introduction</a></li><li><a class="docs-link active" href=https://doks.netlify.app/docs/prologue/quick-start/>Quick Start</a></li><li><a class=docs-link href=https://doks.netlify.app/docs/prologue/commands/>Commands</a></li></ul><h3>Help</h3><ul class=list-unstyled><li><a class=docs-link href=https://doks.netlify.app/docs/help/how-to-update/>How to Update</a></li><li><a class=docs-link href=https://doks.netlify.app/docs/help/troubleshooting/>Troubleshooting</a></li><li><a class=docs-link href=https://doks.netlify.app/docs/help/faq/>FAQ</a></li></ul></nav></div><nav class="docs-toc d-none d-xl-block col-xl-3" aria-label="Secondary navigation"><div class=page-links><h3>On this page</h3><nav id=TableOfContents><ul><li><a href=#requirements>Requirements</a></li><li><a href=#start-a-new-doks-project>Start a new Doks project</a><ul><li><a href=#create-a-new-site>Create a new site</a></li><li><a href=#change-directories>Change directories</a></li><li><a href=#install-dependencies>Install dependencies</a></li><li><a href=#start-development-server>Start development server</a></li></ul></li><li><a href=#other-commands>Other commands</a></li></ul></nav></div></nav><main class="docs-content col-lg-11 col-xl-9"><h1>Quick Start</h1><p class=lead>One page summary of how to start a new Doks project.</p><h2 id=requirements>Requirements<a href=#requirements class=anchor aria-hidden=true>#</a></h2><p>Doks uses npm to centralize dependency management, making it <a href=https://doks.netlify.app/docs/help/how-to-update/>easy to update</a> resources, build tooling, plugins, and build scripts:</p><ul><li>Download and install <a href=https://nodejs.org/>Node.js</a> (it includes npm) for your platform.</li></ul><h2 id=start-a-new-doks-project>Start a new Doks project<a href=#start-a-new-doks-project class=anchor aria-hidden=true>#</a></h2><p>Create a new site, change directories, install dependencies, and start development server.</p><h3 id=create-a-new-site>Create a new site<a href=#create-a-new-site class=anchor aria-hidden=true>#</a></h3><p>Doks is available as a child theme, and a starter theme:</p><ul><li>Use the Doks child theme, if you do <strong>not</strong> plan to customize a lot, and/or need future Doks updates.</li><li>Use the Doks starter theme, if you plan to customize a lot, and/or do <strong>not</strong> need future Doks updates.</li></ul><p>Not quite sure? Use the Doks child theme.</p><h4 id=doks-child-theme>Doks child theme<a href=#doks-child-theme class=anchor aria-hidden=true>#</a></h4><div class=doks-clipboard><button class="btn-clipboard btn btn-link" data-clipboard-text="git clone https://github.com/h-enk/doks-child-theme.git my-doks-site"><span class=copy-status></span></button></div><pre><code class=language-bash>git clone https://github.com/h-enk/doks-child-theme.git my-doks-site
</code></pre><h4 id=doks-starter-theme>Doks starter theme<a href=#doks-starter-theme class=anchor aria-hidden=true>#</a></h4><div class=doks-clipboard><button class="btn-clipboard btn btn-link" data-clipboard-text="git clone https://github.com/h-enk/doks.git my-doks-site"><span class=copy-status></span></button></div><pre><code class=language-bash>git clone https://github.com/h-enk/doks.git my-doks-site
</code></pre><h3 id=change-directories>Change directories<a href=#change-directories class=anchor aria-hidden=true>#</a></h3><div class=doks-clipboard><button class="btn-clipboard btn btn-link" data-clipboard-text="cd my-doks-site"><span class=copy-status></span></button></div><pre><code class=language-bash>cd my-doks-site
</code></pre><h3 id=install-dependencies>Install dependencies<a href=#install-dependencies class=anchor aria-hidden=true>#</a></h3><div class=doks-clipboard><button class="btn-clipboard btn btn-link" data-clipboard-text="npm install"><span class=copy-status></span></button></div><pre><code class=language-bash>npm install
</code></pre><h3 id=start-development-server>Start development server<a href=#start-development-server class=anchor aria-hidden=true>#</a></h3><div class=doks-clipboard><button class="btn-clipboard btn btn-link" data-clipboard-text="npm run start"><span class=copy-status></span></button></div><pre><code class=language-bash>npm run start
</code></pre><p>Doks will start the Hugo development webserver accessible by default at <code>http://localhost:1313</code>. Saved changes will live reload in the browser.</p><h2 id=other-commands>Other commands<a href=#other-commands class=anchor aria-hidden=true>#</a></h2><p>Doks comes with commands for common tasks. <a href=https://doks.netlify.app/docs/prologue/commands/>Commands →</a></p><div class="docs-navigation d-flex justify-content-between"><a href=https://doks.netlify.app/docs/prologue/introduction/><div class="card my-1"><div class="card-body py-2">&larr; Introduction</div></div></a><a class=ms-auto href=https://doks.netlify.app/docs/prologue/commands/><div class="card my-1"><div class="card-body py-2">Commands &rarr;</div></div></a></div></main></div></div></div><footer class="footer text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://www.netlify.com/>Netlify</a>, <a href=https://gohugo.io/>Hugo</a>, and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://doks.netlify.app/js/highlight.min.8cdbefd08ec63ef25f4b2510ae50c13b3d9ed43e25a15ddb55f14c33130e68cf8be3131ccf2d087c49f5f21fe88c2f0e2715a21f936047d0d0b85dc48cb864b9.js integrity="sha512-jNvv0I7GPvJfSyUQrlDBOz2e1D4loV3bVfFMMxMOaM+L4xMczy0IfEn18h/ojC8OJxWiH5NgR9DQuF3EjLhkuQ==" crossorigin=anonymous defer></script><script src=https://doks.netlify.app/main.min.89223fc6eee34e2dc10266cff3c7fc87949c595388f775ec6e93132410cef77e5ff7f24a81db03c9b9eb6d2e6d75ea5a7d22945c574b65dfeb426f65af771230.js integrity="sha512-iSI/xu7jTi3BAmbP88f8h5ScWVOI93XsbpMTJBDO935f9/JKgdsDybnrbS5tdepafSKUXFdLZd/rQm9lr3cSMA==" crossorigin=anonymous defer></script><script src=https://doks.netlify.app/index.min.58db0f580faae7faeadf727fa5e869035387710b04ec731ed3121467e6764b3da9556f7daf17f358ec728a375ec4da2cf29e438fb83e570a5b09834d2dab3e8a.js integrity="sha512-WNsPWA+q5/rq33J/pehpA1OHcQsE7HMe0xIUZ+Z2Sz2pVW99rxfzWOxyijdexNos8p5Dj7g+VwpbCYNNLas+ig==" crossorigin=anonymous defer></script></body></html>