github
/
filebrowser
mirror of https://github.com/filebrowser/filebrowser
1
0
Fork 0
Code Issues Releases Wiki Activity

add docs

pull/29/head
Henrique Dias 2015-10-16 20:00:26 +01:00
parent 00e9e849ea
commit 09f4d90142
1 changed files with 69 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
docs.html Normal file
View File

@ -0,0 +1,69 @@
<!DOCTYPE html>
<html>
<head>
<title>hugo - Caddy Directives</title>
{{.Include "/includes/docs-head.html"}}
</head>
<body>
<main>
<h1>hugo <div class="tag addon">Addon</div></h1>
<div class="addon-message">
<div class="heading"><i class="fa fa-plus-circle"></i> Addon</div>
This directive is a Caddy extension. Questions should be directed to its maintainer. <a href="https://github.com/hacdias/caddy-hugo">github.com/hacdias/caddy-hugo</a>
</div>
<p>
hugo allows you to deploy and manage a static site with an web-based admin interface where you can edit content, schedule posts, upload files, etc. The admin interface will be available at /admin on your website. It is built to be used with <a href="http://gohugo.io/">Hugo</a> - which is bundled with the plugin so you don't have to install it separately.
</p>
<p>
<b>Requirements:</b> this add-on does not create a new Hugo site for you; you'll need to run <code>hugo new site</code> if you don't already have a Hugo site.
</p>
<h3>Syntax</h3>
<code class="block"><span class="hl-directive">root</span> <span class="hl-subdirective">public</span>
<span class="hl-directive">hugo</span> <span class="hl-subdirective">dir</span> {
<span class="hl-subdirective">styles</span> <i>file</i>
<span class="hl-subdirective">args</span> <i>cmd</i>
}</code>
<ul>
<li><b>public</b> is the folder with the public content.</li>
<li><b>dir</b> is the folder where the commands are going to be executed. By default, it is the current working directory.</li>
<li><b>file</b> is the relative path to <code>public</code> folder of the admin UI styles. These styles won't replace the defaults, they will be added.</li>
<li><b>cmd</b> must be surrounded by double quotes and it corresponds to the Hugo flags you want to use.</li>
</ul>
<p>
All of the directives above are optional.
</p>
<p>
To schedule a post, its <code>date</code> field must be in '2006-01-02 15:04:05-07:00' format.
</p>
<p>
This directive should be used with <a href="/docs/root">root</a>, <a href="/docs/basicauth">basicauth</a> and <a href="/docs/errors">errors</a> middleware to have the best experience. See the examples to know more.
</p>
<h3 id="examples">Examples</h3>
<p>
A simple configuration to use with Hugo static website generator:
</p>
<code class="block"><span class="hl-directive">localhost:8080</span> <span class="hl-comment"># website URL and port</span>
<span class="hl-directive">root</span> public <span class="hl-comment"># the folder where Hugo generates the website</span>
<span class="hl-directive">basicauth</span> /admin user pass <span class="hl-comment"># protect the admin area using HTTP basic auth</span>
<span class="hl-directive">hugo</span> <span class="hl-comment"># enable the admin panel</span></code>
<footer>
&copy; 2015
</footer>
</main>
{{.Include "/includes/docs-nav.html"}}
</body>
</html>