website/docs/prologue/commands/index.html

13 lines
12 KiB
HTML
Raw Normal View History

<!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=/fonts/vendor/jost/jost-v4-latin-regular.woff2 type=font/woff2 crossorigin><link rel=preload as=font href=/fonts/vendor/jost/jost-v4-latin-700.woff2 type=font/woff2 crossorigin><link rel=stylesheet href=/main.0795b139a9cfb98e53f63a199a82c50f5de397994a745bf310faf3e391fa60c6261c021d004e40236c54585f2192a5ebf93cfe8175d8df4bb962b714c088fec2.css integrity="sha512-B5WxOanPuY5T9joZmoLFD13jl5lKdFvzEPrz45H6YMYmHAIdAE5AI2xUWF8hkqXr+Tz+gXXY30u5YrcUwIj+wg==" 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>Commands - mCaptcha</title><meta name=description content="Doks comes with commands for common tasks."><link rel=canonical href=/docs/prologue/commands/><meta name=twitter:card content="summary_large_image"><meta name=twitter:image content="/doks.png"><meta name=twitter:title content="Commands"><meta name=twitter:description content="Doks comes with commands for common tasks."><meta name=twitter:site content="@"><meta name=twitter:creator content="@"><meta property="og:title" content="Commands"><meta property="og:description" content="Doks comes with commands for common tasks."><meta property="og:type" content="article"><meta property="og:url" content="/docs/prologue/commands/"><meta property="og:image" content="/doks.png"><meta property="article:published_time" content="2020-10-13T15:21:01+02:00"><meta property="article:modified_time" content="2020-10-13T15:21:01+02:00"><meta property="og:site_name" content="mCaptcha"><meta property="article:publisher" content="https://www.facebook.com/"><meta property="article:author" content="https://www.facebook.com/"><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":"\/"},{"@type":"ListItem","position":2,"name":"Docsprologuecommands","item":"\/docsprologuecommands\/"}]}</script><meta name=theme-color content="#fff"><link rel=apple-touch-icon sizes=180x180 href=/apple-touch-icon.png><link rel=icon type=image/png sizes=32x32 href=/favicon-32x32.png><link rel=icon type=image/png sizes=16x16 href=/favicon-16x16.png><link rel=manifest href=/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=/>mCaptcha</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://github.com/mCaptcha><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=/docs/prologue/introduction/>Docs</a></li><li class=nav-item><a class=nav-link href=/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=/docs/prologue/introduction/>Introduction</a></li><li><a class=docs-link href=/docs/prologue/quick-start/>Quick Start</a></li><li><a class="docs-link active" href=/docs/prologue/commands/>Commands</a></li></ul><h3>Help</h3><ul class=list-unstyled><li><a class=docs-link href=/docs/help/how-to-update/>How to Update</a></li><li><a class=docs-link href=/docs/help/troubleshooting/>Troubleshooting</a></li><li><a class=docs-link href=/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=#start>start</a></li><li><a href=#lint>lint</a><ul><li><a href=#scripts>scripts</a></li><li><a href=#styles>styles</a></li><li><a href=#markdown>markdown</a></li></ul></li><li><a href=#clean>clean</a></li><li><a href=#build>build</a><ul><li><a href=#functions>functions</a></li><li><a href=#preview>preview</a></li></ul></li></ul></nav></div></nav><main class="docs-content col-lg-11 col-xl-9"><h1>Commands</h1><p class=lead>Doks comes with commands for common tasks.</p><div class="alert alert-warning d-flex" role=alert><div class="flex-shrink-1 alert-icon">💡</div><div class=w-100>You can change the commands in the scripts section of `./package.json`.</div></div><h2 id=start>start<a href=#start class=anchor aria-hidden=true>#</a></h2><p>Start local development server:</p><button class="btn-clipboard btn btn-sm btn-link" data-clipboard-text="npm run start"><span class=copy-status></span></button><div class=highlight><pre class=chroma><code class=language
</code></pre></div><h2 id=lint>lint<a href=#lint class=anchor aria-hidden=true>#</a></h2><p>Check scripts, styles, and markdown for errors:</p><button class="btn-clipboard btn btn-sm btn-link" data-clipboard-text="npm run lint"><span class=copy-status></span></button><div class=highlight><pre class=chroma><code class=language-bash data-lang=bash>npm run lint
</code></pre></div><h3 id=scripts>scripts<a href=#scripts class=anchor aria-hidden=true>#</a></h3><p>Check scripts for errors:</p><button class="btn-clipboard btn btn-sm btn-link" data-clipboard-text="npm run lint:scripts"><span class=copy-status></span></button><div class=highlight><pre class=chroma><code class=language-bash data-lang=bash>npm run lint:scripts <span class=o>[</span>-- --fix<span class=o>]</span>
</code></pre></div><h3 id=styles>styles<a href=#styles class=anchor aria-hidden=true>#</a></h3><p>Check styles for errors:</p><button class="btn-clipboard btn btn-sm btn-link" data-clipboard-text="npm run lint:styles"><span class=copy-status></span></button><div class=highlight><pre class=chroma><code class=language-bash data-lang=bash>npm run lint:styles <span class=o>[</span>-- --fix<span class=o>]</span>
</code></pre></div><h3 id=markdown>markdown<a href=#markdown class=anchor aria-hidden=true>#</a></h3><p>Check markdown for errors:</p><button class="btn-clipboard btn btn-sm btn-link" data-clipboard-text="npm run lint:markdown"><span class=copy-status></span></button><div class=highlight><pre class=chroma><code class=language-bash data-lang=bash>npm run lint:markdown <span class=o>[</span>-- --fix<span class=o>]</span>
</code></pre></div><h2 id=clean>clean<a href=#clean class=anchor aria-hidden=true>#</a></h2><p>Delete temporary directories:</p><button class="btn-clipboard btn btn-sm btn-link" data-clipboard-text="npm run clean"><span class=copy-status></span></button><div class=highlight><pre class=chroma><code class=language-bash data-lang=bash>npm run clean
</code></pre></div><h2 id=build>build<a href=#build class=anchor aria-hidden=true>#</a></h2><p>Build production website:</p><button class="btn-clipboard btn btn-sm btn-link" data-clipboard-text="npm run build"><span class=copy-status></span></button><div class=highlight><pre class=chroma><code class=language-bash data-lang=bash>npm run build
</code></pre></div><h3 id=functions>functions<a href=#functions class=anchor aria-hidden=true>#</a></h3><p>Build Lambda functions:</p><button class="btn-clipboard btn btn-sm btn-link" data-clipboard-text="npm run build:functions"><span class=copy-status></span></button><div class=highlight><pre class=chroma><code class=language-bash data-lang=bash>npm run build:functions
</code></pre></div><h3 id=preview>preview<a href=#preview class=anchor aria-hidden=true>#</a></h3><p>Build production website including draft and future content:</p><button class="btn-clipboard btn btn-sm btn-link" data-clipboard-text="npm run build:preview"><span class=copy-status></span></button><div class=highlight><pre class=chroma><code class=language-bash data-lang=bash>npm run build:preview
</code></pre></div><p class=edit-page><a href=https://github.com/mCaptcha/website/blob/master/content/docs/prologue/commands.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class="docs-navigation d-flex justify-content-between"><a href=/docs/prologue/quick-start/><div class="card my-1"><div class="card-body py-2">&larr; Quick Start</div></div></a><a class=ms-auto href=/docs/help/how-to-update/><div class="card my-1"><div class="card-body py-2">How to Update &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://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=/main.min.db67f0caa6a5788b691b9509981d6e5943f4b8d829170a674f468d4b23671ce4017c47a0a22116a8fc2f2de556c8b48f1afecd86707066f2f022c5dd83e8ea3c.js integrity="sha512-22fwyqaleItpG5UJmB1uWUP0uNgpFwpnT0aNSyNnHOQBfEegoiEWqPwvLeVWyLSPGv7NhnBwZvLwIsXdg+jqPA==" crossorigin=anonymous defer></script><script src=/index.min.864533b2dd6520e4998eeed427a7de08f3e4b2fe837b75990ab0de3dbcc7854f0be37faa2fa0c598f28833a0b426a2cda7438ad0464292d09bc4c57109684a5b.js integrity="sha512-hkUzst1lIOSZju7UJ6feCPPksv6De3WZCrDePbzHhU8L43+qL6DFmPKIM6C0JqLNp0OK0EZCktCbxMVxCWhKWw==" crossorigin=anonymous defer></script></body></html>