diff options
author | Waylan Limberg <waylan@gmail.com> | 2009-03-17 22:25:59 -0400 |
---|---|---|
committer | Waylan Limberg <waylan@gmail.com> | 2009-03-17 22:25:59 -0400 |
commit | 6a5635697c3770ece8a969fdb630a705d3d89d28 (patch) | |
tree | 61c2870d8e02a217ed7fbc7c8976f2e16dee215b /docs/using_as_module.txt | |
parent | 38100c98962e14d1db31b279d4d7b267a96faf0b (diff) | |
download | markdown-6a5635697c3770ece8a969fdb630a705d3d89d28.tar.gz markdown-6a5635697c3770ece8a969fdb630a705d3d89d28.tar.bz2 markdown-6a5635697c3770ece8a969fdb630a705d3d89d28.zip |
Fixed various typos etc in the docs.
Diffstat (limited to 'docs/using_as_module.txt')
-rw-r--r-- | docs/using_as_module.txt | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/using_as_module.txt b/docs/using_as_module.txt index da6b1fd..cfeb88d 100644 --- a/docs/using_as_module.txt +++ b/docs/using_as_module.txt @@ -61,7 +61,7 @@ The ``Markdown`` class has the method ``convertFile`` which reads in a file and writes out to a file-like-object: md = markdown.Markdown() - md.convertFile(input="in.txt", output="out.html", encoding="uft8") + md.convertFile(input="in.txt", output="out.html", encoding="utf8") The markdown module also includes a shortcut function ``markdownFromFile`` that wraps the above method. @@ -112,9 +112,9 @@ still create links using Markdown syntax.) markdown.HTML_REMOVED_TEXT = "--RAW HTML IS NOT ALLOWED--" md = markdown.Markdown(safe_mode="replace") - **Note**: You may edit the value of ``HTML_REMOVED_TEXT`` directly in - markdown.py but you will need to remember to do so every time you upgrade - to a newer version of Markdown. + **Note**: You could edit the value of ``HTML_REMOVED_TEXT`` directly in + markdown/__init__.py but you will need to remember to do so every time you + upgrade to a newer version of Markdown. Therefore, this is not recommended. * To remove HTML, set ``safe_mode="remove"``. Any raw HTML will be completely stripped from the text with no warning to the author. @@ -127,7 +127,7 @@ Output Formats If Markdown is outputing (X)HTML as part of a web page, most likely you will want the output to match the (X)HTML version used by the rest of your page/site. -Currenlty, Markdown offers two output formats out of the box; "HTML4" and +Currently, Markdown offers two output formats out of the box; "HTML4" and "XHTML1" (the default) . Markdown will also accept the formats "HTML" and "XHTML" which currently map to "HTML4" and "XHTML" respectively. However, you should use the more explicit keys as the general keys may change in the |