updated branch; this is ready for review for inclusion in IkIWiki

[git.ikiwiki.info.git] / doc / plugins / contrib / opengraph.mdwn

diff --git a/doc/plugins/contrib/opengraph.mdwn b/doc/plugins/contrib/opengraph.mdwn
index a393532d0305f83ed6fde130766c9f25afc1de22..9932c50d2faae483b7a25f179e355cf0ca1bd8bb 100644 (file)
--- a/doc/plugins/contrib/opengraph.mdwn
+++ b/doc/plugins/contrib/opengraph.mdwn
@@ -1,3 +1,11 @@
+# TL;DR
+
+**Plugin**: [opengraph.pm](https://notabug.org/hiatobr/ikiwiki-plugin-opengraph/raw/master/opengraph.pm)
+
+**Source**: [git](https://notabug.org/hiatobr/ikiwiki-plugin-opengraph)
+
+---
+
 [[!toc]]
 
 ---
@@ -14,6 +22,7 @@ This plugin implements the Open Graph tags in the head of the hmtl for all pages
 For more information on what is Open Graph, visit [[!wikipedia Open_Graph]].
 To test your site against the Open Graph rules, use the tool available on <https://developers.facebook.com/tools/debug/og/object/>.
 
+# DISCLAIMER
 
 > **WARNING: Open Graph is modern spyware. You should use this if and only if you don't mind making the readers of your wiki/blog being tracked by evil corporations without their consent. By using this plugin you are being mean to the people who are reading your content. You have been warned.**
 
@@ -48,7 +57,7 @@ Add to the configuration in your [[blog.setup|/setup#index5h2]] file.
 
 Add *opengraph* to the list of plugins:
 
-    add_plugins => [qw{goodstuff opengraph}]
+    add_plugins: [qw{goodstuff opengraph}]
 
 ---
 
@@ -68,6 +77,8 @@ puting it after the <title> tag.
 
 ...that's not a bug. It's an issue. Issues shall be reported [here](https://notabug.org/hiatobr/ikiwiki-plugin-opengraph/issues)
 
+Seriously, I don't know how to fetch the current page's description. Help on that is appreciated.
+
 ---
 
 # LICENSE AND COPYRIGHT
@@ -91,8 +102,8 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
 
 # SEE ALSO
 
-[[index]]
+[[Ikiwiki|index]]
 
 [[!wikipedia Open_Graph]]
 
-[[plugins/contrib/opengraph]]
+<https://ikiwiki.info/plugins/contrib/opengraph>