瀏覽代碼

Improve Interlinks plugin ReadMe

Justin Mayer 8 年之前
父節點
當前提交
71f6cc44be
共有 1 個文件被更改,包括 21 次插入20 次删除
  1. 21 20
      interlinks/readme.md

+ 21 - 20
interlinks/readme.md

@@ -1,28 +1,30 @@
 Interlinks
-=========================
+==========
 
-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.
+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 your Pelican
+settings file. This is subsequently replaced with the actual URL in the generated
+HTML output.
 
 
 Requirements
---------------------
-``interlinks`` requires BeautifulSoup
+------------
+
+This plugin requires BeautifulSoup:
 
 	pip install beautifulsoup4
 
 Installation
---------------------
+------------
 
-Install the plugin normally (plugins folder), then add interlinks in the settings.py:
+Put the plugin into your plugins folder, then add Interlinks in your settings file:
 
 	PLUGINS = ["interlinks"]
-	
+
 Usage
-------------------
+-----
 
-The interlinks are specified in the settings.py file as (example):
+Interlinks are specified in your settings file. Here is an example:
 
 	INTERLINKS = {
 	    'wikipedia_en': 'http://en.wikipedia.org/wiki/',
@@ -30,20 +32,19 @@ The interlinks are specified in the settings.py file as (example):
 	    'ddg': 'https://duckduckgo.com/?q='
 	}
 
-There's also a default key, ``this``, that is mapped to the ``SITEURL`` variable.
+There's also a default key, `this`, that is mapped to the `SITEURL` variable.
 
-Then, in a blog post, you just create a normal link but adding the ``keyword>`` syntax in the url specification, followed by the rest of the url. 
+Then, in your content, you just create a normal link but add the `keyword>` syntax as the URL scheme, followed by the rest of the URL.
 
-Example 
--------------------
-(markdown syntax)
+Example (Markdown syntax)
+-------------------------
 
 	[Normal boring link](http://www.example.com). But this is a [cool link](this>) that links to this site.
 
-	Search in [Wikipedia](wikipedia_en>python), ([here](wikipedia_es>python) in spanish). Also can [search](ddg>python) it.
+	Search in [Wikipedia](wikipedia_en>python), ([here](wikipedia_es>python) in Spanish). You can also [search](ddg>python) it.
 
-All the above will be rendered as: 
+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). You can also <a href="https://duckduckgo.com/?q=python">search</a> it.</p>