Support :kbd: shortcut

Closes #497.
github · Jun 5, 2015 · 07cf187 · cpitclaudel · Jun 21, 2020 · 07cf187
1 parent 14a8a61
commit 07cf187
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/lib/github/commands/rest2html b/lib/github/commands/rest2html
@@ -44,6 +44,8 @@ except:
 
 import codecs
 
+from docutils import nodes
+from docutils.parsers.rst import roles
 from docutils.core import publish_parts
 from docutils.writers.html4css1 import Writer, HTMLTranslator
 
@@ -127,6 +129,10 @@ class GitHubHTMLTranslator(HTMLTranslator):
         self.body.append(self.starttag(node, 'img', **atts))
       self.body.append(self.context.pop())
 
+def kbd(name, rawtext, text, lineno, inliner, options=None, content=None):
+
+  return [nodes.raw('', '<kbd>%s</kbd>' % text, format='html')], []
+
 def main():
     """
     Parses the given ReST file or the redirected string input and returns the
@@ -145,6 +151,8 @@ def main():
     writer = Writer()
     writer.translator_class = GitHubHTMLTranslator
 
+    roles.register_canonical_role('kbd', kbd)
+
     parts = publish_parts(text, writer=writer, settings_overrides=SETTINGS)
     if 'html_body' in parts:
         html = parts['html_body']

diff --git a/test/markups/README.rst b/test/markups/README.rst
@@ -57,3 +57,5 @@ Field list
 :123456789 1234: this should work even with the default :)
 
 [email protected]
+
+Press :kbd:`Ctrl+C` to quit
diff --git a/test/markups/README.rst.html b/test/markups/README.rst.html
@@ -75,3 +75,5 @@ <h2><a href="#id2">Field list</a></h2>
 </table>
 
 <p><a href="mailto:[email protected]">[email protected]</a></p>
+
+<p>Press <kbd>Ctrl+C</kbd> to quit</p>