Skip to content

Improve docs/extensions/index.txt #157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 4, 2012
Merged

Improve docs/extensions/index.txt #157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
32e8b97
Remove exec bit from extensions/fenced_code.py
mitya57 Nov 3, 2012
2ce3d7b
docs/extensions/index.txt: make it clear what name to pass for extens…
mitya57 Nov 3, 2012
7c228b3
docs/basic.css: Improve CSS a bit
mitya57 Nov 3, 2012
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 15 additions & 8 deletions docs/basic.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,18 +246,21 @@ div.body p.centered {

/* -- tables ---------------------------------------------------------------- */

table.docutils {
table {
border: 0 solid #dce;
border-collapse: collapse;
}

table.docutils td, table.docutils th {
table td, table th {
padding: 2px 5px 2px 5px;
border-left: 0;
background-color: #eef;
}

table.docutils td p.last, table.docutils th p.last {
table td {
border: 1px solid #ddd;
background-color: #eef;
}

table td p.last, table th p.last {
margin-bottom: 0;
}

Expand All @@ -269,8 +272,8 @@ table.footnote td, table.footnote th {
border: 0 !important;
}

table.docutils th {
border-top: 1px solid #cac;
table th {
border: 1px solid #cac;
background-color: #ede;
}

Expand All @@ -280,7 +283,7 @@ th {
}

th.head {
text-align: center;
text-align: center;
}

/* -- other body styles ----------------------------------------------------- */
Expand Down Expand Up @@ -371,6 +374,10 @@ pre {
overflow-y: hidden;
}

code {
font-size: 1.1em;
}

td.linenos pre {
padding: 5px 0px;
border: 0;
Expand Down
72 changes: 53 additions & 19 deletions docs/extensions/index.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ actual source files.
To use an extension, pass it's name to markdown with the `extensions` keyword.
See the [Library Reference](../reference.html#extensions) for more details.

markdown.markdown(some_text, extensions=['extra', 'nl2br'])
markdown.markdown(some_text, extensions=['footnotes', 'nl2br'])
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm using extra in the "Markdown Extra" section below, so let's use something different here.


From the command line, specify an extension with the `-x` option. See the
[Command Line docs](../cli.html) or use the `--help` option for more details.

python -m markdown -x extra input.txt > output.html
python -m markdown -x footnotes -x tables input.txt > output.html

Officially Supported Extensions
-------------------------------
Expand All @@ -31,23 +31,57 @@ maintained here and all bug reports should be made to the project. If you
have a typical install of Python-Markdown, these extensions are already
available to you.

* [Extra](extra.html)
* [Abbreviations](abbreviations.html)
* [Attribute Lists](attr_list.html)
* [Definition Lists](definition_lists.html)
* [Fenced Code Blocks](fenced_code_blocks.html)
* [Footnotes](footnotes.html)
* [Tables](tables.html)
* [Smart Strong](smart_strong.html)
* [CodeHilite](code_hilite.html)
* [HTML Tidy](html_tidy.html)
* [HeaderId](header_id.html)
* [Meta-Data](meta_data.html)
* [New Line to Break](nl2br.html)
* [RSS](rss.html)
* [Sane Lists](sane_lists.html)
* [Table of Contents](toc.html)
* [WikiLinks](wikilinks.html)
### Markdown Extra

You can enable **all** these extensions just as if it was a single
`extra` extension. Example:

markdown.markdown(some_text, extensions=['extra', 'codehilite'])

Extension | Name in Python-Markdown
--------- | -----------------------
[Abbreviations][] | `abbr`
[Attribute Lists][] | `attr_list`
[Definition Lists][] | `def_list`
[Fenced Code Blocks][] | `fenced_code`
[Footnotes][] | `footnotes`
[Tables][] | `tables`
[Smart Strong][] | `smart_strong`

[Abbreviations]: abbreviations.html
[Attribute Lists]: attr_list.html
[Definition Lists]: definition_lists.html
[Fenced Code Blocks]: fenced_code_blocks.html
[Footnotes]: footnotes.html
[Tables]: tables.html
[Smart Strong]: smart_strong.html

### Other extensions

There are also some extensions that are not included in Markdown Extra
but come in the standard Python-Markdown library.

Extension | Name in Python-Markdown
--------- | -----------------------
[CodeHilite][] | `codehilite`
[HTML Tidy][] | `html_tidy`
[HeaderId] | `headerid`
[Meta-Data] | `meta`
[New Line to Break] | `nl2br`
[RSS] | `rss`
[Sane Lists] | `sane_lists`
[Table of Contents] | `toc`
[WikiLinks] | `wikilinks`

[CodeHilite]: code_hilite.html
[HTML Tidy]: html_tidy.html
[HeaderId]: header_id.html
[Meta-Data]: meta_data.html
[New Line to Break]: nl2br.html
[RSS]: rss.html
[Sane Lists]: sane_lists.html
[Table of Contents]: toc.html
[WikiLinks]: wikilinks.html

Third Party Extensions
----------------------
Expand Down
Empty file modified markdown/extensions/fenced_code.py
100755 → 100644
View file
Open in desktop
Empty file.