1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
"""
Keys.
pymdownx.keys
Markdown extension for keystroke (user keyboard input) formatting.
It wraps the syntax `++key+key+key++` (for individual keystrokes with modifiers)
or `++"string"++` (for continuous keyboard input) into HTML `<kbd>` elements.
If a key is found in the extension's database, its `<kbd>` element gets a matching class.
Common synonyms are included, e.g. `++pg-up++` will match as `++page-up++`.
## Config
If `strict` is `True`, the entire series of keystrokes is wrapped into an outer`<kbd>` element, and then,
each keystroke is wrapped into a separate inner `<kbd>` element, which matches the HTML5 spec.
If `strict` is `False`, an outer `<span>` is used, which matches the practice on Github or StackOverflow.
The resulting `<kbd>` elements are separated by `separator` (`+` by default, can be `''` or something else).
If `camel_case` is `True`, `++PageUp++` will match the same as `++page-up++`.
The database can be extended or modified with the `key_map` dict.
## Examples
### Input
```
Press ++Shift+Alt+PgUp++, type in ++"Hello"++ and press ++Enter++.
```
### Config 1
```
pymdownx.keys:
camel_case: true
strict: false
separator: '+'
```
### Output 1
```
<p>Press <span class="keys"><kbd class="key-shift">Shift</kbd><span>+</span><kbd
class="key-alt">Alt</kbd><span>+</span><kbd class="key-page-up">Page Up</kbd></span>, type in <span
class="keys"><kbd>Hello</kbd></span> and press <span class="keys"><kbd class="key-enter">Enter</kbd></span>.</p>
```
### Config 2
```
pymdownx.keys:
camel_case: true
strict: true
separator: ''
```
### Output 2
```
<p>Press <kbd class="keys"><kbd class="key-shift">Shift</kbd><kbd class="key-alt">Alt</kbd><kbd
class="key-page-up">Page Up</kbd></kbd>, type in <kbd class="keys"><kbd>Hello</kbd></kbd> and press <kbd
class="keys"><kbd class="key-enter">Enter</kbd></kbd>.</p>
```
Idea by Adam Twardoch and coded by Isaac Muse.
Copyright (c) 2017 Isaac Muse <isaacmuse@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions
of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
"""
import html
from markdown import Extension
from markdown.inlinepatterns import InlineProcessor
from markdown import util as md_util
import xml.etree.ElementTree as etree
from . import util
from . import keymap_db as keymap
import re
RE_EARLY_KBD = r'''(?x)
(?:
# Escape
(?<!\\)(?P<escapes>(?:\\{2})+)(?=\+)|
# Key
(?<!\\)\+{2}
(
(?:(?:[\w\-]+|"(?:\\.|[^"])+"|\'(?:\\.|[^\'])+\')\+)*?
(?:[\w\-]+|"(?:\\.|[^"])+"|\'(?:\\.|[^\'])+\')
)
\+{2}
)
'''
RE_KBD = r'\+{2}([\w\-]+(?:\+[\w\-]+)*?)\+{2}'
ESCAPE_RE = re.compile(r'''(?<!\\)(?:\\\\)*\\(.)''')
UNESCAPED_PLUS = re.compile(r'''(?<!\\)(?:\\\\)*(\+)''')
ESCAPED_BSLASH = '{}{}{}'.format(md_util.STX, ord('\\'), md_util.ETX)
DOUBLE_BSLASH = '\\\\'
class KeysPattern(InlineProcessor):
"""Return kbd tag."""
def __init__(self, pattern, config, md, early=False):
"""Initialize."""
self.ksep = config['separator']
self.strict = config['strict']
self.classes = config['class'].split(' ')
self.map = self.merge(keymap.keymap, config['key_map'])
self.aliases = keymap.aliases
self.camel = config['camel_case']
self.early = early
super().__init__(pattern, md)
def merge(self, x, y):
"""Given two dicts, merge them into a new dict."""
z = x.copy()
z.update(y)
return z
def normalize(self, key):
"""Normalize the value."""
if not self.camel:
return key
norm_key = []
last = ''
for c in key:
if c.isupper():
if not last or last == '-':
norm_key.append(c.lower())
else:
norm_key.extend(['-', c.lower()])
else:
norm_key.append(c)
last = c
return ''.join(norm_key)
def process_key(self, key):
"""Process key."""
if key.startswith(('"', "'")):
value = (None, html.unescape(ESCAPE_RE.sub(r'\1', key[1:-1])).strip())
else:
norm_key = self.normalize(key)
canonical_key = self.aliases.get(norm_key, norm_key)
name = self.map.get(canonical_key, None)
value = (canonical_key, name) if name else None
return value
def handleMatch(self, m, data):
"""Handle kbd pattern matches."""
if self.early:
if m.group(1):
return m.group('escapes').replace(DOUBLE_BSLASH, ESCAPED_BSLASH), m.start(0), m.end(0)
quoted = 0
content = []
for key in UNESCAPED_PLUS.split(m.group(2)):
if key != '+':
if key.startswith(('"', "'")):
quoted += 1
content.append(self.process_key(key))
# Defer unquoted cases until later to avoid parsing URLs
if not quoted:
return None, None, None
else:
content = [self.process_key(key) for key in m.group(1).split('+')]
if None in content:
return None, None, None
el = etree.Element(
('kbd' if self.strict else 'span'),
({'class': ' '.join(self.classes)} if self.classes else {})
)
last = None
for item_class, item_name in content:
classes = []
if item_class:
classes.append('key-' + item_class)
if last is not None and self.ksep:
span = etree.SubElement(el, 'span')
span.text = md_util.AtomicString(self.ksep)
attr = {}
if classes:
attr['class'] = ' '.join(classes)
kbd = etree.SubElement(el, 'kbd', attr)
kbd.text = md_util.AtomicString(item_name)
last = kbd
return el, m.start(0), m.end(0)
class KeysExtension(Extension):
"""Add `keys`` extension to Markdown class."""
def __init__(self, *args, **kwargs):
"""Initialize."""
self.config = {
'separator': ['+', "Provide a keyboard separator - Default: \"+\""],
'strict': [False, "Format keys and menus according to HTML5 spec - Default: False"],
'class': ['keys', "Provide class(es) for the kbd elements - Default: \"keys\""],
'camel_case': [False, 'Allow camelCase conversion for key names PgDn -> pg-dn - Default: False'],
'key_map': [{}, 'Additional keys to include or keys to override - Default: {}']
}
super().__init__(*args, **kwargs)
def extendMarkdown(self, md):
"""Add support for keys."""
util.escape_chars(md, ['+'])
md.inlinePatterns.register(KeysPattern(RE_EARLY_KBD, self.getConfigs(), md, early=True), "keys-custom", 185)
md.inlinePatterns.register(KeysPattern(RE_KBD, self.getConfigs(), md), "keys", 70)
def makeExtension(*args, **kwargs):
"""Return extension."""
return KeysExtension(*args, **kwargs)
|
