Browse files

Update documentation for autolinking.

  • Loading branch information...
1 parent fe7eae8 commit 98e1ff4d923858c30524540aba2035d056838bda @rsenk330 committed Dec 20, 2012
Showing with 12 additions and 3 deletions.
  1. +5 −3 README.md
  2. +7 −0 pypeline/filters/autolink.py
View
8 README.md
@@ -32,14 +32,16 @@ Most of the filters provided by [HTML::Pipeline](https://github.com/jch/html-pip
Filters that are currently completed:
-* **MarkdownFilter**: Markdown -> HTML
-* **PlainTextInputFilter**: Escapes HTML tags and wraps in a div
+* **MarkdownFilter***: Markdown -> HTML
+* **PlainTextInputFilter***: Escapes HTML tags and wraps in a div
+* **AutolinkFilter**: Automatic linking of URLs
* **MentionFilter**: Replace `@mentions` with a URL
* **SyntaxHighlightFilter**: Syntax highlighting
+*Only one of these can be used at a time, and they must be the _first_ filter in the pipeline.
+
Filters that are being worked on:
-* **AutolinkFilter**: Automatic linking of URLs
* **EmojiFilter**: Replace [emoji](http://www.emoji-cheat-sheet.com/) tags with images
* **HttpsFilter**: Replace HTTP URLs with HTTPS
* **ImageMaxWidthFilter**: Link to the full size image when creating image previews
View
7 pypeline/filters/autolink.py
@@ -2,6 +2,13 @@
from lxml.html.clean import autolink_html
def autolink(context={}):
+ """The autolink filter automatically add links.
+
+ It does this by looking for things that look like links, which includes
+ anything starting with `http`, `https`, and `mailto` and replaces it
+ with an anchor element.
+
+ """
def render(content):
return autolink_html(content)

0 comments on commit 98e1ff4

Please sign in to comment.