comments

Author: AddisonSchiller

mfr/extensions/md/README.md

@@ -27,7 +27,7 @@ To add a new library, you need to make sure its loadable in md.js somehow, eithe
 
 Libraries should try to use the same version as the ones used on the OSF. The plugins do not matter as much, but `markdown-it` and `Mathjax` you should try to match exactly because styling can change between versions.
 
-To add a new library that is not already set up to export to `root` can be a bit tricky, but the gist of it is, wrap the plugin in this code:
+To add a new library that is not already set up to export to `root` can be a bit tricky but the gist of it is, wrap the plugin in this code:
 
 ```javascript
 ;(function (root, factory) {
@@ -49,4 +49,4 @@ To add a new library that is not already set up to export to `root` can be a bit
 
 And then modify it to work in this context. See other plugins for examples.
 
-Then, in md.js, you can add a plugin to the markdown renderer by adding a `.use(<window.<PLUGIN_NAME>)` after loading the file into `viewer.mako`
+Then in md.js, you can add a plugin to the markdown renderer by adding a `.use(window.<PLUGIN_NAME>)` after loading the file into `viewer.mako`.

mfr/extensions/md/render.py

@@ -19,8 +19,8 @@ def __init__(self, *args, **kwargs):
     def render(self):
         """Render a markdown file to html."""
         with open(self.file_path, 'r') as fp:
-            # Bleach will bug out on unclosed tags. OSF wiki does not. This is
-            # Due to versioning problems: https://github.com/mozilla/bleach/issues/271
+            # Bleach will bug out on unclosed tags. OSF wiki does not have this issue.
+            # This is due to versioning problems: https://github.com/mozilla/bleach/issues/271
             body = bleach.clean(fp.read(), **BLEACH_WHITELIST)
             return self.TEMPLATE.render(base=self.assets_url, body=body)
 

mfr/extensions/md/settings.py

@@ -1,3 +1,4 @@
+# This list comes from the OSF
 BLEACH_WHITELIST = {
     'tags': [
         'a', 'abbr', 'acronym', 'b', 'bdo', 'big', 'blockquote', 'br',

mfr/extensions/md/static/js/md.js

@@ -19,4 +19,4 @@ var markdown = new MarkdownIt('commonmark', {
     .disable('strikethrough');
 
 
-document.getElementById("jaxified").innerHTML = markdown.render(document.getElementById("jaxified").innerHTML);
+document.getElementById("jaxified").innerHTML = markdown.render(document.getElementById("jaxified").innerHTML);