Browse Source

add docs for favorites

pull/82/head
Aaron Parecki 4 years ago
parent
commit
34afa1f5f2
4 changed files with 34 additions and 2 deletions
  1. +3
    -2
      controllers/static.php
  2. BIN
      public/images/favorite-interface.jpg
  3. +1
    -0
      views/docs/creating-posts.php
  4. +30
    -0
      views/docs/favorite.php

+ 3
- 2
controllers/static.php View File

@ -5,8 +5,9 @@ function doc_pages($page=null) {
'signing-in' => 'Signing In',
'creating-posts' => 'Creating Posts',
'editor' => 'Rich Editor',
'note' => 'Note Interface',
'bookmark' => 'Bookmark Interface',
'note' => 'Creating a Note',
'bookmark' => 'Creating a Bookmark',
'favorite' => 'Favoriting a Post',
'syndication' => 'Syndication',
'post-status' => 'Post Status',
];

BIN
public/images/favorite-interface.jpg View File

Before After
Width: 750  |  Height: 553  |  Size: 33 KiB

+ 1
- 0
views/docs/creating-posts.php View File

@ -10,6 +10,7 @@
<li><a href="/docs/editor">Rich Editor</a></li>
<li><a href="/docs/note">Note</a></li>
<li><a href="/docs/bookmark">Bookmark</a></li>
<li><a href="/docs/favorite">Favorite</a></li>
<li>... more documentation soon!</li>
</ul>

+ 30
- 0
views/docs/favorite.php View File

@ -0,0 +1,30 @@
<div class="narrow">
<?= partial('partials/header') ?>
<h2>Favorite</h2>
<img src="/images/favorite-interface.jpg" style="max-width: 300px; float: right;">
<p>The favorite interface is for creating favorite posts.</p>
<h3>Bookmarklet</h3>
<p>On the favorite interface, you can drag a bookmarklet to your bookmarks toolbar. This will let you favorite pages that you're viewing with a single click.</p>
<h3>Post Properties</h3>
<p>The following properties will be sent in the Micropub request. This request will be sent as a form-encoded request.</p>
<p>The access token is sent in the Authorization HTTP header:</p>
<pre>Authorization: Bearer XXXXXXXXX</pre>
<ul>
<li><code>h=entry</code> - This indicates that this is a request to create a new <a href="https://indieweb.org/h-entry">h-entry</a> post.</li>
<li><code>like-of</code> - This is the URL that you are favoriting.</li>
</ul>
<hr>
<p>Back to <a href="/docs/creating-posts">Creating Posts</a></p>
</div>

Loading…
Cancel
Save