]> projects.mako.cc - pyblosxom-markdown2/commitdiff
Update the instructions in the module docstring.
authorSean Hammond <seanhammond@lavabit.com>
Tue, 28 Sep 2010 01:04:39 +0000 (02:04 +0100)
committerSean Hammond <seanhammond@lavabit.com>
Tue, 28 Sep 2010 01:04:39 +0000 (02:04 +0100)
markdown-plugin.py

index b96f0f097df2e3d05c27dfd28e55274155b35695..ed01d66aa277089c02b722fe6c7a0dfc10bdb361 100644 (file)
@@ -1,22 +1,23 @@
 #!/usr/bin/env python
 """
 #!/usr/bin/env python
 """
-markdown-plugin.py -- A Python-Markdown v2.x plugin for PyBlosxom.
+markdown-plugin.py -- A Python Markdown v2.x plugin for PyBlosxom.
 
 
-This plugin requires Python-Markdown v2.x, which you can download from:
+This plugin requires Python Markdown v2.x, which you can download from:
 
        http://www.freewisdom.org/projects/python-markdown/
 
 
        http://www.freewisdom.org/projects/python-markdown/
 
-Extract python-markdown into your pyblosxom plugins dir alongside this
-plugin. Your plugins dir should look like this:
+Extract the 'markdown' directory from the Python Markdown tarball (the
+directory containing __init__.py, not the Markdown-2.x.y directory)  into your
+pyblosxom plugins dir alongside this plugin. Your plugins dir should look like
+this:
 
        plugins/ <-- your pyblosxom plugins dir
                markdown-plugin.py <-- this file
 
        plugins/ <-- your pyblosxom plugins dir
                markdown-plugin.py <-- this file
-               markdown.py <-- the python-markdown command line script
-               markdown/ <-- directory containing python-markdown's files
+               markdown/ <-- the Python Markdown module
                ... <-- (any other pyblosxom plugins)
 
                ... <-- (any other pyblosxom plugins)
 
-Now any posts with filenames ending in `.mkdn` will be passed through
-python-markdown.
+Now any posts with filenames ending in one of the FILENAME_EXTENSIONS defined
+below will be passed through python-markdown.
 
 Copyright (C) Benjamin Mako Hill, 2005
 Updated for python-markdown 2 by seanh 2009
 
 Copyright (C) Benjamin Mako Hill, 2005
 Updated for python-markdown 2 by seanh 2009

Benjamin Mako Hill || Want to submit a patch?