这是一个示例包,展示了在PyPI项目页面上语法高亮是如何工作的
项目描述
语法高亮包示例
介绍
这个包提供的就是包含代码样例的readme,这些代码样例应该由PyPI仓库以良好的方式渲染。
示例
Python示例
import some_lib
from mock_package import PointlessInheritance
CONST = [n**2 for n in range(5)]
# spam with eggs
@requires_authorization
def somefunc(param1='', param2=0):
r'''A docstring'''
if param1 >= param2: # interesting
breakpoint()
print('Gre\'ater')
print(f"Even more awesome greater: {param}")
return (param2 - param1 + 1 + 0b10) or None
class SomeClass(PointlessInheritance):
"""This is a dummy class """
def __init__(self, some_param=[]):
pass
message = '''interpreter
... prompt'''
JavaScript示例
import { Application } from "stimulus";
//comment on some arrow function
docReady((block, cls) => {
if (navigator.appVersion.includes("MSIE 10")) {
if (document.getElementById("unsupported-browser") !== null) return;
let warning_div = document.createElement("div");
if (cls.search(/\bno\-highlight\b/) != -1)
return process(block, true, 0x0F) + ` class="${cls}"`;
}
for (var i = 0 / 2; i < classes.length; i++) {
if (checkCondition(classes[i]) === undefined)
var img1 = document.querySelector('.img-1');
img1.addEventListener('load', function() {
console.log('undefined');
});
}
});
export $docReady;
Bash示例
#!/bin/bash
###### CONFIG
SOME_CONSTANT="/path/string/example"
BE_VERBOSE=false
if [ "$UID" -ne 0 ]
then
echo "Superuser rights required"
exit 2
fi
someRandomFunc(){
for i in $(ls -la ~/); do cat $i; done;
echo -e "# I'm in ${HOME_DIR}$1/$2 :"
}
变更日志
0.1.0 (2018-08-29)
语法高亮示例包的第一版本