You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

60 lines
2.5 KiB

  1. <div class="narrow">
  2. <?= partial('partials/header') ?>
  3. <h2 id="introduction">Introduction</h2>
  4. <div class="col-xs-6 col-md-4" style="float: right;">
  5. <span class="thumbnail"><img src="/images/quill-ui.png"></span>
  6. </div>
  7. <p>This is a simple <a href="">Micropub</a> client for
  8. creating text posts on your own website. To use it, you will need to turn your website
  9. into an OAuth provider, and implement a Micropub endpoint that this app will send
  10. requests to.</p>
  11. <p>Once you've signed in, you'll see an interface like the one shown which you can use to
  12. write a post. Clicking "post" will make a Micropub request to your endpoint.<p>
  13. <h2 id="endpoints">Configuring Endpoints</h2>
  14. <h3>Authorization Endpoint</h3>
  15. <?= partial('partials/auth-endpoint-help') ?>
  16. <h3>Token Endpoint</h3>
  17. <?= partial('partials/token-endpoint-help') ?>
  18. <h3>Micropub Endpoint</h3>
  19. <?= partial('partials/micropub-endpoint-help') ?>
  20. <p>The <a href="/creating-a-micropub-endpoint">Creating a Micropub Endpoint</a> tutorial will walk you through how to handle incoming POST requests from apps like this.</p>
  21. <h2 id="syndication">Syndication Targets</h2>
  22. <p>You can provide a list of supported syndication targets that will appear as checkboxes when you are creating a new post.</p>
  23. <p>To do this, your Micropub endpoint will need to respond to a GET request containing a query string of <code>q=syndicate-to</code>. This request will be made with the access token that was generated for this app, so you can choose which syndication targets you want to allow this app to use.</p>
  24. <p>Below is the request and expected response that Quill looks for.</p>
  25. <pre><code>GET /micropub?q=syndicate-to HTTP/1.1
  26. Authorization: Bearer xxxxxxxxxx
  27. HTTP/1.1 200 OK
  28. Content-type: application/x-www-form-urlencoded
  29. syndicate-to[][]
  30. </code></pre>
  31. <p>The response should be a form-encoded reply with an array, <code>syndicate-to</code> of all the supported syndication targets. The actual values are up to your Micropub endpoint, but a good convention is to use the domain name of the service (e.g., or domain name and username (e.g.</p>
  32. <p>If you do include the domain name, Quill will be able to show icons for recognized services next to the checkboxes.</p>
  33. <p>Quill will check for your supported syndication targets when you sign in, but there is also a link on the new post screen to manually re-check if you'd like.</p>
  34. </div>