本文整理汇总了Python中mkdocs.build.convert_markdown函数的典型用法代码示例。如果您正苦于以下问题：Python convert_markdown函数的具体用法？Python convert_markdown怎么用？Python convert_markdown使用的例子？那么恭喜您, 这里精选的函数代码示例或许可以为您提供帮助。
在下文中一共展示了convert_markdown函数的15个代码示例，这些例子默认根据受欢迎程度排序。您可以为喜欢或者感觉有用的代码点赞，您的评价将有助于系统推荐出更棒的Python代码示例。
示例1: test_strict_mode_valid
def test_strict_mode_valid(self):
pages = [("index.md",), ("internal.md",), ("sub/internal.md")]
site_nav = nav.SiteNavigation(pages)
valid = "[test](internal.md)"
build.convert_markdown(valid, site_nav, strict=False)
build.convert_markdown(valid, site_nav, strict=True)示例2: test_strict_mode_invalid
def test_strict_mode_invalid(self):
pages = [("index.md",), ("internal.md",), ("sub/internal.md")]
site_nav = nav.SiteNavigation(pages)
invalid = "[test](bad_link.md)"
build.convert_markdown(invalid, site_nav, strict=False)
self.assertRaises(MarkdownNotFound, build.convert_markdown, invalid, site_nav, strict=True)示例3: test_absolute_link
def test_absolute_link(self):
pages = [
'index.md',
'sub/index.md',
]
site_nav = nav.SiteNavigation(pages)
markdown = "[test 1](/index.md) [test 2](/sub/index.md)"
cfg = load_config({'strict': True})
build.convert_markdown(markdown, cfg, site_nav)示例4: test_strict_mode_valid
def test_strict_mode_valid(self):
pages = [
'index.md',
'internal.md',
'sub/internal.md',
]
site_nav = nav.SiteNavigation(pages)
valid = "[test](internal.md)"
build.convert_markdown(valid, load_config({'strict': False}), site_nav)
build.convert_markdown(valid, load_config({'strict': True}), site_nav)示例5: test_strict_mode_invalid
def test_strict_mode_invalid(self):
pages = [
'index.md',
'internal.md',
'sub/internal.md',
]
site_nav = nav.SiteNavigation(pages)
invalid = "[test](bad_link.md)"
build.convert_markdown(invalid, load_config({'strict': False}), site_nav)
self.assertRaises(
MarkdownNotFound,
build.convert_markdown, invalid, load_config({'strict': True}), site_nav)示例6: test_not_use_directory_urls
def test_not_use_directory_urls(self):
md_text = "An [internal link](internal.md) to another document."
expected = '<p>An <a href="internal/index.html">internal link</a> to another document.</p>'
pages = [("internal.md",)]
site_navigation = nav.SiteNavigation(pages, use_directory_urls=False)
html, toc, meta = build.convert_markdown(md_text, site_navigation=site_navigation)
self.assertEqual(html.strip(), expected.strip())示例7: html_docs
def html_docs(self):
text = self.raw_docs
if not text:
return ''
text = _pre_process_objects(text)
return build.convert_markdown(text, extensions=config.base_config.get('markdown_extensions', []))[0]示例8: test_convert_markdown
def test_convert_markdown(self):
"""
Ensure that basic Markdown -> HTML and TOC works.
"""
html, toc, meta = build.convert_markdown(dedent("""
page_title: custom title
# Heading 1
This is some text.
# Heading 2
And some more text.
"""))
expected_html = dedent("""
<h1 id="heading-1">Heading 1</h1>
<p>This is some text.</p>
<h1 id="heading-2">Heading 2</h1>
<p>And some more text.</p>
""")
expected_toc = dedent("""
Heading 1 - #heading-1
Heading 2 - #heading-2
""")
expected_meta = {'page_title': ['custom title']}
self.assertEqual(html.strip(), expected_html)
self.assertEqual(str(toc).strip(), expected_toc)
self.assertEqual(meta, expected_meta)示例9: test_markdown_custom_extension
def test_markdown_custom_extension(self):
"""
Check that an extension applies when requested in the arguments to
`convert_markdown`.
"""
md_input = "foo__bar__baz"
# Check that the plugin is not active when not requested.
expected_without_smartstrong = "<p>foo<strong>bar</strong>baz</p>"
html_base, _, _ = build.convert_markdown(md_input)
self.assertEqual(html_base.strip(), expected_without_smartstrong)
# Check that the plugin is active when requested.
expected_with_smartstrong = "<p>foo__bar__baz</p>"
html_ext, _, _ = build.convert_markdown(md_input, ['smart_strong'])
self.assertEqual(html_ext.strip(), expected_with_smartstrong)示例10: test_markdown_duplicate_custom_extension
def test_markdown_duplicate_custom_extension(self):
"""
Duplicated extension names should not cause problems.
"""
md_input = "foo"
html_ext, _, _ = build.convert_markdown(md_input, ['toc'])
self.assertEqual(html_ext.strip(), '<p>foo</p>')示例11: test_markdown_table_extension
def test_markdown_table_extension(self):
"""
Ensure that the table extension is supported.
"""
html, toc, meta = build.convert_markdown(dedent("""
First Header | Second Header
-------------- | --------------
Content Cell 1 | Content Cell 2
Content Cell 3 | Content Cell 4
"""))
expected_html = dedent("""
<table>
<thead>
<tr>
<th>First Header</th>
<th>Second Header</th>
</tr>
</thead>
<tbody>
<tr>
<td>Content Cell 1</td>
<td>Content Cell 2</td>
</tr>
<tr>
<td>Content Cell 3</td>
<td>Content Cell 4</td>
</tr>
</tbody>
</table>
""")
self.assertEqual(html.strip(), expected_html)示例12: test_anchor_only_link
def test_anchor_only_link(self):
pages = [("index.md",), ("internal.md",), ("sub/internal.md")]
site_navigation = nav.SiteNavigation(pages)
for page in site_navigation.walk_pages():
markdown = "[test](#test)"
html, _, _ = build.convert_markdown(markdown, site_navigation=site_navigation)
self.assertEqual(html, '<p><a href="#test">test</a></p>')示例13: test_ignore_email_links
def test_ignore_email_links(self):
md_text = 'A <[email protected]> and an [link](mailto:[email protected]).'
expected = ''.join([
'<p>A <a href="mailto:aut',
'olink@exampl',
'e.com">autolin',
'k@example.com',
'</a> and an <a href="mailto:[email protected]">link</a>.</p>'
])
html, toc, meta = build.convert_markdown(md_text, load_config())
self.assertEqual(html.strip(), expected.strip())示例14: test_anchor_only_link
def test_anchor_only_link(self):
pages = [
'index.md',
'internal.md',
'sub/internal.md',
]
site_navigation = nav.SiteNavigation(pages)
for page in site_navigation.walk_pages():
markdown = '[test](#test)'
html, _, _ = build.convert_markdown(markdown, load_config(), site_navigation=site_navigation)
self.assertEqual(html, '<p><a href="#test">test</a></p>')示例15: test_convert_internal_asbolute_media
def test_convert_internal_asbolute_media(self):
"""Test absolute image URL's are correct for different base_urls"""
pages = [("index.md",), ("internal.md",), ("sub/internal.md")]
site_navigation = nav.SiteNavigation(pages)
expected_results = ("./img/initial-layout.png", "../img/initial-layout.png", "../../img/initial-layout.png")
template = '<p><img alt="The initial MkDocs layout" src="%s" /></p>'
for (page, expected) in zip(site_navigation.walk_pages(), expected_results):
md_text = ""
html, _, _ = build.convert_markdown(md_text, site_navigation=site_navigation)
self.assertEqual(html, template % expected)