documon
Version:
A documentation system for mortals. Use with any language.
84 lines (60 loc) • 2.61 kB
HTML
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Install</title>
<meta name="description" content="more.install">
<!-- Normalize -->
<link rel="stylesheet" href="assets/vendor/normalize.css">
<!-- prettify -->
<link rel="stylesheet" href="assets/vendor/prettify/codamike.css">
<script src="assets/vendor/prettify/prettify.js"></script>
<!-- Documon Pages Info. (Used by various classes to identify this page.) -->
<script>
var pageCtx = {
id : "more.install",
name: "Install"
}
</script>
<!-- theme
<link rel="stylesheet" href="assets/fonts/Fira_Sans/FiraSans.css">
<link rel="stylesheet" href="assets/fonts/Inconsolata/inconsolata.css">
-->
<link rel="stylesheet" href="assets/css/pages.css">
<script src="assets/js/documon/Storage.js"></script>
<script src="assets/js/documon/Access.js"></script>
<script src="assets/js/documon/Pages.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-106684927-1', 'auto');
ga('send', 'pageview');
</script>
</head>
<body>
<div class="page">
<div class="more"><h1 id="installation">Installation</h1>
<p>Nothing special needs ot be done to run Documon, aside from ensuring that <a href="https://nodejs.org">Node</a> is installed on your system.</p>
<p><a href="https://www.documon.net/downloads/documon.zip">ↆ Download Documon</a></p>
<p>Download it, unzip it, then run it:</p>
<pre><code>cd "path/to/documon"
node ./index.js "path/to/source/files"</code></pre>
<h3 id="project-installation-with-npm">Project Installation with NPM</h3>
<p>To incorporate Documon into your project / build system use:</p>
<pre><code>cd "/your/project/path"
npm install documon</code></pre>
<p>… this allows you to build documentation from within your project using:</p>
<pre><code>var docs = require("documon");
docs("/path/to/src");</code></pre>
<h3 id="see-also">See Also</h3>
<ul>
<li><a href="more.options">Options</a></li>
<li><a href="more.examples">Examples</a></li>
</ul></div>
</div>
<div class="footer">Generated by <a href="http://www.documon.net" target="_blank">Documon</a></div>
</body>
</html>