summaryrefslogtreecommitdiff
path: root/views/docs/index.php
diff options
context:
space:
mode:
authorAaron Parecki <aaron@parecki.com>2017-01-06 11:00:34 -0800
committerAaron Parecki <aaron@parecki.com>2017-01-06 11:00:34 -0800
commit92615f6183c94c039d7591068768ae21ce6e0b11 (patch)
tree8eaf8a6a0a25eca5ee5c4a66f0b28cbffabca168 /views/docs/index.php
parentbdff359178d6696d1934a3e350d6cd1b33282251 (diff)
expand documentation
Diffstat (limited to 'views/docs/index.php')
-rw-r--r--views/docs/index.php29
1 files changed, 29 insertions, 0 deletions
diff --git a/views/docs/index.php b/views/docs/index.php
new file mode 100644
index 0000000..2054a62
--- /dev/null
+++ b/views/docs/index.php
@@ -0,0 +1,29 @@
+<div class="narrow">
+ <?= partial('partials/header') ?>
+
+ <h2>Introduction</h2>
+
+ <div class="col-xs-6 col-md-4" style="float: right;">
+ <span class="thumbnail"><img src="/images/quill-note-interface.png"></span>
+ </div>
+
+ <p>Quill is a simple <a href="https://indieweb.org/micropub">Micropub</a> client for
+ creating posts on your own website. To use it, your website will need to have
+ a Micropub endpoint, and this app will send requests to it to create posts.</p>
+
+ <p>There are Micropub plugins for various content management systems such as
+ <a href="https://wordpress.org/plugins/micropub/">Wordpress</a>, and is supported
+ natively by some software such as <a href="https://withknown.com">Known</a>.
+ It's also a relatively simple protocol you can implement if you are building
+ your own website.</p>
+
+ <p>Once you've signed in, you'll be able to use the various interfaces see an interface like the one shown which you can use to
+ write a post. Clicking "post" will make a Micropub request to your endpoint.<p>
+
+ <ul>
+ <?php foreach($this->pages as $k=>$v): ?>
+ <li><a href="/docs/<?= $k ?>"><?= $v ?></a></li>
+ <?php endforeach; ?>
+ </ul>
+
+</div>