创建标记格式文本
markdown-strings的Python项目详细描述
===
标记字符串包
===
markdown是一种带有纯文本格式语法的标记语言。此包允许创建符合标记的字符串。下面是带有用法示例的功能摘要。
注意:对于不将
格式化为代码(内联代码和代码块)的所有函数,都将转义星号和下划线。
features
==
==
header
----
返回指定级别的header。
关键字参数:
style--指定header样式(默认atx)。"atx"样式使用
散列符号,有6个级别。"setext"样式对级别1和级别2的标题分别使用破折号或等于号,并且仅限于这两个级别。
指定样式范围外的级别将导致值错误。
:
>;标题("主标题",1)
‘主标题‘
>>>gt>gt;标题(小标题,4)
‘小标题‘
<
;标题(setext style,2,"setext")
‘小标题‘
>>>gt>gt;标题(小标题,小标题,4)
>
:
>
>
>
gt;>;斜体("此文本为斜体")
'\u此文本为斜体
bold
---
>返回粗体格式文本。
:
>;bold("此文本为粗体")
'**此文本为粗体**'
内联代码
----
>返回格式化的内联代码。
:
>;内联代码("此文本是代码")
'`此文本是代码`'
--指定要限制代码的语言(默认为空)。
:
>;>;代码块("这是一个简单的代码块。")
"这是一个简单的代码块。"
>;>;代码块("这是一个简单的代码块"。 '这是一个简单的代码块。\\ n但它有一个换行符!'
>;>;代码块("此代码块具有指定的语言。","python")
```python\\此代码块具有指定的语言; >;>;代码块("so\\ nmany\\ nlinebreaks.","python")
```python\\nso\\n许多行中断。
link
---
>返回一个内联链接。
:
>;link("这是一个链接","https://github.com/abactel/markdown-strings")
'[这是一个链接](https://github.com/abactel/markdown-strings)
image
----
>返回内联图像。
关键字参数:
title--指定图像的标题,如悬停在其上方时所见。
::
>;>>图像("这是图像","https://tinyurl.com/bright green tree")
![这是一个图像](https://tinyurl.com/bright green tree)
>;>>图像("这是一个图像","https://tinyurl.com/bright green tree","tree")
'![这是一个图像](https://tinyurl.com/bright-green-tree)"tree"
unordered list
----
从数组返回无序列表。
:
>;>;无序列表(["first","second","third","fourth"])
-first\\n-second\\n-third\\n-第四个"
>">>;无序列表([1,2,3,4,5])
'-1\\n-2\\n-3\\n-4\\n-5'
-
-
从数组返回有序列表。
:
>;有序列表(["第一个"、"第二个"、"第三个"、"第四个"])
'1。第一个。第二个。第三\N4。第四个'
blockquote
——
返回一个blockquote。
:
>;>blockquote("a简单的blockquote")
'>;简单的blockquote"
horizontal rule
----
返回水平规则。
关键字参数:
长度--指定规则的长度(默认值79,最小值3)。
样式--用于规则的字符(可以是be either "_" or "*").
If the length is too low, or the style is invalid, a ValueError is raised.
::
>>> horizontal_rule()
'_______________________________________________________________________________'
>>> horizontal_rule(length=5, style="*"
"***"
"
>非标准降价
===
删除线
----
>返回带删除线格式的文本。
:
>;删除线("这是一个谎言")
'~这是一个谎言~'
任务列表([["be born",true],["be dead",false]])
'-[x]beborn\\n-[]bedead'
当使用"print"显示时,这将显示为:
:
-[x]出生
-[]死亡
设置行的填充格式。
:
>;>;表格行(["第一列","第二列","第三列])
'第一列","第二列","第三行"
>;>;表格行(["第一列","第二列","第三行"],[10,10,10])
'第一列第二列第三列'
分隔符行
----
>返回一个分隔符行,以便在表中使用。
:
>;table_delimiter_u row(3)
'————————'
>
table from columns
——
返回一个格式化的表,该表由表示列的数组生成。
这将用于生成字符串
格式的格式化表。每个列中的项目数不需要是一致的。
:
>;>table_from_columns([["name","abactel","bob"],["user","4b4c73l","]]]
''name user \n abctel 4b4c73l阿巴克特尔4B4C73L
鲍勃||
helper函数
=esc_format("普通文本")
"普通文本"
>;>esc_format("带**粗体**的文本")
"带\\*\\*粗体的文本"\\*\\\*'
>;>esc_format("带斜体的文本")
"带\\斜体的文本"
esc_format("带复杂格式的文本")
"带复杂格式的文本"
"
标记字符串包
===
markdown是一种带有纯文本格式语法的标记语言。此包允许创建符合标记的字符串。下面是带有用法示例的功能摘要。
注意:对于不将
格式化为代码(内联代码和代码块)的所有函数,都将转义星号和下划线。
features
==
==
header
----
返回指定级别的header。
关键字参数:
style--指定header样式(默认atx)。"atx"样式使用
散列符号,有6个级别。"setext"样式对级别1和级别2的标题分别使用破折号或等于号,并且仅限于这两个级别。
指定样式范围外的级别将导致值错误。
:
>;标题("主标题",1)
‘主标题‘
>>>gt>gt;标题(小标题,4)
‘小标题‘
<
;标题(setext style,2,"setext")
‘小标题‘
>>>gt>gt;标题(小标题,小标题,4)
>
:
>
>
>
gt;>;斜体("此文本为斜体")
'\u此文本为斜体
bold
---
>返回粗体格式文本。
:
>;bold("此文本为粗体")
'**此文本为粗体**'
内联代码
----
>返回格式化的内联代码。
:
>;内联代码("此文本是代码")
'`此文本是代码`'
--指定要限制代码的语言(默认为空)。
:
>;>;代码块("这是一个简单的代码块。")
"这是一个简单的代码块。"
>;>;代码块("这是一个简单的代码块"。
>;>;代码块("此代码块具有指定的语言。","python")
```python\\此代码块具有指定的语言;
```python\\nso\\n许多行中断。
link
---
>返回一个内联链接。
:
>;link("这是一个链接","https://github.com/abactel/markdown-strings")
'[这是一个链接](https://github.com/abactel/markdown-strings)
image
----
>返回内联图像。
关键字参数:
title--指定图像的标题,如悬停在其上方时所见。
::
>;>>图像("这是图像","https://tinyurl.com/bright green tree")
![这是一个图像](https://tinyurl.com/bright green tree)
>;>>图像("这是一个图像","https://tinyurl.com/bright green tree","tree")
'![这是一个图像](https://tinyurl.com/bright-green-tree)"tree"
unordered list
----
从数组返回无序列表。
:
>;>;无序列表(["first","second","third","fourth"])
-first\\n-second\\n-third\\n-第四个"
>">>;无序列表([1,2,3,4,5])
'-1\\n-2\\n-3\\n-4\\n-5'
-
-
从数组返回有序列表。
:
>;有序列表(["第一个"、"第二个"、"第三个"、"第四个"])
'1。第一个。第二个。第三\N4。第四个'
blockquote
——
返回一个blockquote。
:
>;>blockquote("a简单的blockquote")
'>;简单的blockquote"
horizontal rule
----
返回水平规则。
关键字参数:
长度--指定规则的长度(默认值79,最小值3)。
样式--用于规则的字符(可以是be either "_" or "*").
If the length is too low, or the style is invalid, a ValueError is raised.
::
>>> horizontal_rule()
'_______________________________________________________________________________'
>>> horizontal_rule(length=5, style="*"
"***"
"
>非标准降价
===
删除线
----
>返回带删除线格式的文本。
:
>;删除线("这是一个谎言")
'~这是一个谎言~'
任务列表([["be born",true],["be dead",false]])
'-[x]beborn\\n-[]bedead'
当使用"print"显示时,这将显示为:
:
-[x]出生
-[]死亡
设置行的填充格式。
:
>;>;表格行(["第一列","第二列","第三列])
'第一列","第二列","第三行"
>;>;表格行(["第一列","第二列","第三行"],[10,10,10])
'第一列第二列第三列'
分隔符行
----
>返回一个分隔符行,以便在表中使用。
:
>;table_delimiter_u row(3)
'————————'
>
table from columns
——
返回一个格式化的表,该表由表示列的数组生成。
这将用于生成字符串
格式的格式化表。每个列中的项目数不需要是一致的。
:
>;>table_from_columns([["name","abactel","bob"],["user","4b4c73l","]]]
''name user \n abctel 4b4c73l阿巴克特尔4B4C73L
鲍勃||
helper函数
=esc_format("普通文本")
"普通文本"
>;>esc_format("带**粗体**的文本")
"带\\*\\*粗体的文本"\\*\\\*'
>;>esc_format("带斜体的文本")
"带\\斜体的文本"
esc_format("带复杂格式的文本")
"带复杂格式的文本"
"