Browse Source

Merge pull request #96 from talha131/patch-1

Improve summary of interlinks plugin
Alexis Metaireau 11 years ago
parent
commit
3b4737325e
1 changed files with 5 additions and 2 deletions
  1. 5 2
      interlinks/readme.md

+ 5 - 2
interlinks/readme.md

@@ -1,7 +1,10 @@
 Interlinks
 =========================
 
-This plugin allows you to include "interwiki" or shortcuts links into the blog, as keyword>rest-of-url
+This plugin lets you add frequently used URLs to your markup using short keywords. Short URL format is 
+``keyword>rest-of-url`` where ``keyword`` is defined in the settings.py. Later it is replaced with acutal URL in
+the generated HTML output.
+
 
 Requirements
 --------------------
@@ -43,4 +46,4 @@ All the above will be rendered as:
 
 	<p><a href="http://www.example.com">Normal boring link</a>. But this is a <a href="http://[yoursite]/index.html">cool link</a> that links to this site.</p>
 	
-	<p>Search in <a href="http://en.wikipedia.org/wiki/python">Wikipedia</a>, (<a href="http://es.wikipedia.org/wiki/python">here</a> in spanish). Also can <a href="https://duckduckgo.com/?q=python">search</a> it.</p>
+	<p>Search in <a href="http://en.wikipedia.org/wiki/python">Wikipedia</a>, (<a href="http://es.wikipedia.org/wiki/python">here</a> in spanish). Also can <a href="https://duckduckgo.com/?q=python">search</a> it.</p>