├── tests ├── __init__.py ├── test_markdown_jinja_tag.py └── test_render_markdown.py ├── pytest.ini ├── .gitignore ├── .github └── workflows │ ├── test.yml │ └── publish.yml ├── setup.py ├── datasette_render_markdown └── __init__.py ├── README.md └── LICENSE /tests/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /pytest.ini: -------------------------------------------------------------------------------- 1 | [pytest] 2 | asyncio_mode = strict 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.db 2 | .vscode 3 | .venv 4 | __pycache__/ 5 | *.py[cod] 6 | *$py.class 7 | venv 8 | .eggs 9 | .pytest_cache 10 | *.egg-info 11 | .DS_Store 12 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: Test 2 | 3 | on: [push, pull_request] 4 | 5 | permissions: 6 | contents: read 7 | 8 | jobs: 9 | test: 10 | runs-on: ubuntu-latest 11 | strategy: 12 | matrix: 13 | python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"] 14 | steps: 15 | - uses: actions/checkout@v3 16 | - name: Set up Python ${{ matrix.python-version }} 17 | uses: actions/setup-python@v4 18 | with: 19 | python-version: ${{ matrix.python-version }} 20 | cache: pip 21 | cache-dependency-path: setup.py 22 | - name: Install dependencies 23 | run: | 24 | pip install '.[test]' 25 | - name: Run tests 26 | run: | 27 | pytest 28 | 29 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup 2 | import os 3 | 4 | VERSION = "2.2.1" 5 | 6 | 7 | def get_long_description(): 8 | with open( 9 | os.path.join(os.path.dirname(os.path.abspath(__file__)), "README.md"), 10 | encoding="utf8", 11 | ) as fp: 12 | return fp.read() 13 | 14 | 15 | setup( 16 | name="datasette-render-markdown", 17 | description="Datasette plugin for rendering Markdown", 18 | long_description=get_long_description(), 19 | long_description_content_type="text/markdown", 20 | author="Simon Willison", 21 | url="https://github.com/simonw/datasette-render-markdown", 22 | license="Apache License, Version 2.0", 23 | version=VERSION, 24 | packages=["datasette_render_markdown"], 25 | entry_points={"datasette": ["render_markdown = datasette_render_markdown"]}, 26 | install_requires=["datasette", "markdown", "bleach"], 27 | extras_require={"test": ["pytest", "pytest-asyncio"]}, 28 | python_requires=">=3.7", 29 | ) 30 | -------------------------------------------------------------------------------- /.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | name: Publish Python Package 2 | 3 | on: 4 | release: 5 | types: [created] 6 | 7 | permissions: 8 | contents: read 9 | 10 | jobs: 11 | test: 12 | runs-on: ubuntu-latest 13 | strategy: 14 | matrix: 15 | python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"] 16 | steps: 17 | - uses: actions/checkout@v3 18 | - name: Set up Python ${{ matrix.python-version }} 19 | uses: actions/setup-python@v4 20 | with: 21 | python-version: ${{ matrix.python-version }} 22 | cache: pip 23 | cache-dependency-path: setup.py 24 | - name: Install dependencies 25 | run: | 26 | pip install '.[test]' 27 | - name: Run tests 28 | run: | 29 | pytest 30 | deploy: 31 | runs-on: ubuntu-latest 32 | needs: [test] 33 | steps: 34 | - uses: actions/checkout@v3 35 | - name: Set up Python 36 | uses: actions/setup-python@v4 37 | with: 38 | python-version: "3.11" 39 | cache: pip 40 | cache-dependency-path: setup.py 41 | - name: Install dependencies 42 | run: | 43 | pip install setuptools wheel twine build 44 | - name: Publish 45 | env: 46 | TWINE_USERNAME: __token__ 47 | TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }} 48 | run: | 49 | python -m build 50 | twine upload dist/* 51 | 52 | -------------------------------------------------------------------------------- /tests/test_markdown_jinja_tag.py: -------------------------------------------------------------------------------- 1 | from datasette.app import Datasette 2 | import pytest 3 | import textwrap 4 | 5 | 6 | @pytest.mark.asyncio 7 | @pytest.mark.parametrize( 8 | "input,expected", 9 | ( 10 | ( 11 | textwrap.dedent( 12 | """ 13 | {% markdown %} 14 | # Data analysis with SQLite and Python 15 | "example" and 'example' 16 | {% endmarkdown %} 17 | """ 18 | ).strip(), 19 | ( 20 | "

Data analysis with SQLite and Python

\n" 21 | "

\"example\" and 'example'

" 22 | ), 23 | ), 24 | # With attributes 25 | ( 26 | textwrap.dedent( 27 | """ 28 | {% markdown extensions="tables" 29 | extra_tags="table thead tr th td tbody" %} 30 | ## Markdown table 31 | 32 | First Header | Second Header 33 | ------------- | ------------- 34 | Content Cell | Content Cell 35 | Content Cell | Content Cell 36 | {% endmarkdown %} 37 | """ 38 | ).strip(), 39 | textwrap.dedent( 40 | """ 41 |

Markdown table

42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 |
First HeaderSecond Header
Content CellContent Cell
Content CellContent Cell
60 | """ 61 | ).strip(), 62 | ), 63 | # extra_attrs 64 | ( 65 | textwrap.dedent( 66 | """ 67 | {% markdown extra_attrs="p:id,class a:name,href" %} 68 | Example 69 |

Paragraph

70 | {% endmarkdown %} 71 | """ 72 | ).strip(), 73 | ( 74 | '

Example

\n' 75 | '

Paragraph

' 76 | ), 77 | ), 78 | # Without that they should be stripped: 79 | ( 80 | textwrap.dedent( 81 | """ 82 | {% markdown %} 83 | Example 84 |

Paragraph

85 | {% endmarkdown %} 86 | """ 87 | ).strip(), 88 | ( 89 | '

Example

\n' 90 | "

Paragraph

" 91 | ), 92 | ), 93 | ), 94 | ) 95 | async def test_render_template_tag(tmpdir, input, expected): 96 | (tmpdir / "template.html").write_text(input, "utf-8") 97 | datasette = Datasette(template_dir=str(tmpdir)) 98 | await datasette.invoke_startup() 99 | rendered = await datasette.render_template(["template.html"]) 100 | expected = '
' + expected + "
" 101 | assert rendered == expected 102 | 103 | 104 | @pytest.mark.asyncio 105 | @pytest.mark.parametrize( 106 | "input,expected_error", 107 | ( 108 | ( 109 | "{% markdown %}", 110 | ( 111 | "Unexpected end of template. Jinja was looking for the following tags: " 112 | "'endmarkdown'. The innermost block that needs to be closed is 'markdown'." 113 | ), 114 | ), 115 | ('{% markdown foo="bar" %}{% endmarkdown %}', "Unknown attribute 'foo'"), 116 | ), 117 | ) 118 | async def test_render_template_tag_errors(tmpdir, input, expected_error): 119 | (tmpdir / "template.html").write_text(input, "utf-8") 120 | datasette = Datasette(template_dir=str(tmpdir)) 121 | await datasette.invoke_startup() 122 | with pytest.raises(Exception) as excinfo: 123 | await datasette.render_template(["template.html"]) 124 | 125 | error = str(excinfo.value) 126 | assert error == expected_error 127 | -------------------------------------------------------------------------------- /datasette_render_markdown/__init__.py: -------------------------------------------------------------------------------- 1 | from bleach.sanitizer import Cleaner 2 | from bleach.linkifier import LinkifyFilter 3 | from bleach.html5lib_shim import Filter 4 | from fnmatch import fnmatch 5 | from functools import partial 6 | from jinja2 import nodes 7 | from jinja2.exceptions import TemplateSyntaxError 8 | from jinja2.ext import Extension 9 | import json 10 | import markdown 11 | from datasette import hookimpl 12 | from markupsafe import Markup 13 | 14 | 15 | @hookimpl() 16 | def render_cell(value, column, table, database, datasette): 17 | if not isinstance(value, str): 18 | return None 19 | should_convert = False 20 | config = ( 21 | datasette.plugin_config( 22 | "datasette-render-markdown", database=database, table=table 23 | ) 24 | or {} 25 | ) 26 | extensions = config.get("extensions") or [] 27 | extra_tags = config.get("extra_tags") or [] 28 | extra_attrs = config.get("extra_attrs") or {} 29 | if column in (config.get("columns") or []): 30 | should_convert = True 31 | 32 | # Also convert to markdown if table ends in _markdown 33 | patterns = config.get("patterns") 34 | if patterns is None: 35 | patterns = ["*_markdown"] 36 | for pattern in patterns: 37 | if fnmatch(column, pattern): 38 | should_convert = True 39 | 40 | if should_convert: 41 | return render_markdown(value, extensions, extra_tags, extra_attrs) 42 | else: 43 | return None 44 | 45 | 46 | def render_markdown(value, extensions=None, extra_tags=None, extra_attrs=None): 47 | if value is None: 48 | return Markup("") 49 | attributes = {"a": ["href"], "img": ["src", "alt"]} 50 | if extra_attrs: 51 | attributes.update(extra_attrs) 52 | cleaner = Cleaner( 53 | tags=[ 54 | "a", 55 | "abbr", 56 | "acronym", 57 | "b", 58 | "blockquote", 59 | "code", 60 | "em", 61 | "i", 62 | "li", 63 | "ol", 64 | "strong", 65 | "ul", 66 | "pre", 67 | "p", 68 | "h1", 69 | "h2", 70 | "h3", 71 | "h4", 72 | "h5", 73 | "h6", 74 | "img", 75 | ] 76 | + (extra_tags or []), 77 | attributes=attributes, 78 | filters=[ImageMaxWidthFilter, partial(LinkifyFilter, skip_tags={"pre"})], 79 | ) 80 | html = cleaner.clean( 81 | markdown.markdown(value, output_format="html5", extensions=extensions or []) 82 | ) 83 | return Markup('
{}
'.format(html)) 84 | 85 | 86 | class ImageMaxWidthFilter(Filter): 87 | """Adds style="max-width: 100%" to any image tags""" 88 | 89 | def __iter__(self): 90 | for token in Filter.__iter__(self): 91 | if token["type"] == "EmptyTag" and token["name"] == "img": 92 | token["data"][(None, "style")] = "max-width: 100%" 93 | yield token 94 | 95 | 96 | @hookimpl 97 | def extra_template_vars(): 98 | return { 99 | "render_markdown": render_markdown, 100 | } 101 | 102 | 103 | class MarkdownExtension(Extension): 104 | tags = set(["markdown"]) 105 | 106 | def __init__(self, environment): 107 | super(MarkdownExtension, self).__init__(environment) 108 | 109 | def parse(self, parser): 110 | # We need this for reporting errors 111 | lineno = next(parser.stream).lineno 112 | 113 | # Gather tokens up to the next block_end ('%}') 114 | gathered = [] 115 | while parser.stream.current.type != "block_end": 116 | gathered.append(next(parser.stream)) 117 | 118 | # If all has gone well, we will have a sequence of triples of tokens: 119 | # (type='name, value='attribute name'), 120 | # (type='assign', value='='), 121 | # (type='string', value='attribute value') 122 | # Anything else is a parse error 123 | 124 | if len(gathered) % 3 != 0: 125 | raise TemplateSyntaxError("Invalid syntax for markdown tag", lineno) 126 | attrs = {} 127 | for i in range(0, len(gathered), 3): 128 | if ( 129 | gathered[i].type != "name" 130 | or gathered[i + 1].type != "assign" 131 | or gathered[i + 2].type != "string" 132 | ): 133 | raise TemplateSyntaxError( 134 | ( 135 | "Invalid syntax for markdown attribute - got " 136 | "'{}', should be name=\"value\"".format( 137 | "".join([str(t.value) for t in gathered[i : i + 3]]), 138 | ) 139 | ), 140 | lineno, 141 | ) 142 | attrs[gathered[i].value] = gathered[i + 2].value 143 | 144 | # Validate the attributes 145 | kwargs = {} 146 | for attr, value in attrs.items(): 147 | if attr in ("extensions", "extra_tags"): 148 | kwargs[attr] = value.split() 149 | elif attr == "extra_attrs": 150 | # Custom syntax: tag:attr1,attr2 tag2:attr3,attr4 151 | extra_attrs = {} 152 | for tag_attrs in value.split(): 153 | tag, attrs = tag_attrs.split(":") 154 | extra_attrs[tag] = attrs.split(",") 155 | kwargs["extra_attrs"] = extra_attrs 156 | else: 157 | raise TemplateSyntaxError("Unknown attribute '{}'".format(attr), lineno) 158 | 159 | body = parser.parse_statements(["name:endmarkdown"], drop_needle=True) 160 | 161 | return nodes.CallBlock( 162 | # I couldn't figure out how to send attrs to the _render_markdown 163 | # method other than json.dumps and then passing as a nodes.Const 164 | self.call_method("_render_markdown", [nodes.Const(json.dumps(kwargs))]), 165 | [], 166 | [], 167 | body, 168 | ).set_lineno(lineno) 169 | 170 | async def _render_markdown(self, kwargs_json, caller): 171 | kwargs = json.loads(kwargs_json) 172 | return render_markdown(await caller(), **kwargs) 173 | 174 | 175 | @hookimpl 176 | def prepare_jinja2_environment(env): 177 | env.add_extension(MarkdownExtension) 178 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # datasette-render-markdown 2 | 3 | [![PyPI](https://img.shields.io/pypi/v/datasette-render-markdown.svg)](https://pypi.org/project/datasette-render-markdown/) 4 | [![Changelog](https://img.shields.io/github/v/release/simonw/datasette-render-markdown?include_prereleases&label=changelog)](https://github.com/simonw/datasette-render-markdown/releases) 5 | [![Tests](https://github.com/simonw/datasette-render-markdown/workflows/Test/badge.svg)](https://github.com/simonw/datasette-render-markdown/actions?query=workflow%3ATest) 6 | [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/datasette-render-markdown/blob/main/LICENSE) 7 | 8 | [Datasette](https://datasette.io/) plugin for rendering Markdown. 9 | 10 | ## Installation 11 | 12 | Install this plugin in the same environment as Datasette to enable this new functionality: 13 | ```bash 14 | datasette install datasette-render-markdown 15 | ``` 16 | ## Usage 17 | 18 | You can explicitly list the columns you would like to treat as Markdown using [plugin configuration](https://datasette.readthedocs.io/en/stable/plugins.html#plugin-configuration) in a `metadata.json` file. 19 | 20 | Add a `"datasette-render-markdown"` configuration block and use a `"columns"` key to list the columns you would like to treat as Markdown values: 21 | 22 | ```json 23 | { 24 | "plugins": { 25 | "datasette-render-markdown": { 26 | "columns": ["body"] 27 | } 28 | } 29 | } 30 | ``` 31 | 32 | This will cause any `body` column in any table to be treated as markdown and safely rendered using [Python-Markdown](https://python-markdown.github.io/). The resulting HTML is then run through [Bleach](https://bleach.readthedocs.io/) to avoid the risk of XSS security problems. 33 | 34 | Save this to `metadata.json` and run Datasette with the `--metadata` flag to load this configuration: 35 | 36 | $ datasette serve mydata.db --metadata metadata.json 37 | 38 | The configuration block can be used at the top level, or it can be applied just to specific databases or tables. Here's how to apply it to just the `entries` table in the `news.db` database: 39 | 40 | ```json 41 | { 42 | "databases": { 43 | "news": { 44 | "tables": { 45 | "entries": { 46 | "plugins": { 47 | "datasette-render-markdown": { 48 | "columns": ["body"] 49 | } 50 | } 51 | } 52 | } 53 | } 54 | } 55 | } 56 | ``` 57 | 58 | And here's how to apply it to every `body` column in every table in the `news.db` database: 59 | 60 | ```json 61 | { 62 | "databases": { 63 | "news": { 64 | "plugins": { 65 | "datasette-render-markdown": { 66 | "columns": ["body"] 67 | } 68 | } 69 | } 70 | } 71 | } 72 | ``` 73 | 74 | ## Columns that match a naming convention 75 | 76 | This plugin can also render markdown in any columns that match a specific naming convention. 77 | 78 | By default, columns that have a name ending in `_markdown` will be rendered. 79 | 80 | You can try this out using the following query: 81 | 82 | ```sql 83 | select '# Hello there 84 | 85 | * This is a list 86 | * of items 87 | 88 | [And a link](https://github.com/simonw/datasette-render-markdown).' 89 | as demo_markdown 90 | ``` 91 | 92 | You can configure a different list of wildcard patterns using the `"patterns"` configuration key. Here's how to render columns that end in either `_markdown` or `_md`: 93 | 94 | ```json 95 | { 96 | "plugins": { 97 | "datasette-render-markdown": { 98 | "patterns": ["*_markdown", "*_md"] 99 | } 100 | } 101 | } 102 | ``` 103 | 104 | To disable wildcard column matching entirely, set `"patterns": []` in your plugin metadata configuration. 105 | 106 | ## Markdown extensions 107 | 108 | The [Python-Markdown library](https://python-markdown.github.io/) that powers this plugin supports extensions, both [bundled](https://python-markdown.github.io/extensions/) and [third-party](https://github.com/Python-Markdown/markdown/wiki/Third-Party-Extensions). These can be used to enable additional Markdown features such as [table support](https://python-markdown.github.io/extensions/tables/). 109 | 110 | You can configure support for extensions using the `"extensions"` key in your plugin metadata configuration. 111 | 112 | Since extensions may introduce new HTML tags, you will also need to add those tags to the list of tags that are allowed by the [Bleach](https://bleach.readthedocs.io/) sanitizer. You can do that using the `"extra_tags"` key, and you can allow-list additional HTML attributes using `"extra_attrs"`. See [the Bleach documentation](https://bleach.readthedocs.io/en/latest/clean.html#allowed-tags-tags) for more information on this. 113 | 114 | Here's how to enable support for [Markdown tables](https://python-markdown.github.io/extensions/tables/): 115 | 116 | ```json 117 | { 118 | "plugins": { 119 | "datasette-render-markdown": { 120 | "extensions": ["tables"], 121 | "extra_tags": ["table", "thead", "tr", "th", "td", "tbody"] 122 | } 123 | } 124 | } 125 | ``` 126 | 127 | ### GitHub-Flavored Markdown 128 | 129 | Enabling [GitHub-Flavored Markdown](https://help.github.com/en/github/writing-on-github) (useful for if you are working with data imported from GitHub using [github-to-sqlite](https://github.com/dogsheep/github-to-sqlite)) is a little more complicated. 130 | 131 | First, you will need to install the [py-gfm](https://py-gfm.readthedocs.io) package: 132 | 133 | $ pip install py-gfm 134 | 135 | Note that `py-gfm` has [a bug](https://github.com/Zopieux/py-gfm/issues/13) that causes it to pin to `Markdown<3.0` - so if you are using it you should install it _before_ installing `datasette-render-markdown` to ensure you get a compatibly version of that dependency. 136 | 137 | Now you can configure it like this. Note that the extension name is `mdx_gfm:GithubFlavoredMarkdownExtension` and you need to allow-list several extra HTML tags and attributes: 138 | 139 | ```json 140 | { 141 | "plugins": { 142 | "datasette-render-markdown": { 143 | "extra_tags": [ 144 | "hr", 145 | "br", 146 | "details", 147 | "summary", 148 | "input" 149 | ], 150 | "extra_attrs": { 151 | "input": [ 152 | "type", 153 | "disabled", 154 | "checked" 155 | ], 156 | }, 157 | "extensions": [ 158 | "mdx_gfm:GithubFlavoredMarkdownExtension" 159 | ] 160 | } 161 | } 162 | } 163 | ``` 164 | 165 | The `` attributes are needed to support rendering checkboxes in issue descriptions. 166 | 167 | ## Markdown in templates 168 | 169 | The plugin introduces a new template tag: `{% markdown %}...{% endmarkdown %}` - which can be used to render Markdown in your Jinja templates. 170 | 171 | ```html+jinja 172 | {% markdown %} 173 | # This will be rendered as markdown 174 | {% endmarkdown %} 175 | ``` 176 | You can use attributes on the `{% markdown %}` tag to enable extensions and allow-list additional tags and attributes: 177 | ```html+jinja 178 | {% markdown 179 | extensions="tables" 180 | extra_tags="table thead tr th td tbody" 181 | extra_attrs="p:id,class a:name,href" %} 182 | ## Markdown table 183 | 184 | First Header | Second Header 185 | ------------- | ------------- 186 | Content Cell | Content Cell 187 | Content Cell | Content Cell 188 | 189 | Example 190 |

Paragraph

191 | {% endmarkdown %} 192 | ``` 193 | The `extensions=` and `extra_tags=` attributes accept a space-separated list of values. 194 | 195 | The `extra_attrs=` attribute accepts a space-separated list of `tag:attr1,attr2` values - each tag can specify one or more attributes that should be allowed. 196 | 197 | You can also use the `{{ render_markdown(...) }}` function, like this: 198 | 199 | ```html+jinja 200 | {{ render_markdown(""" 201 | ## Markdown table 202 | 203 | First Header | Second Header 204 | ------------- | ------------- 205 | Content Cell | Content Cell 206 | Content Cell | Content Cell 207 | """, extensions=["tables"], 208 | extra_tags=["table", "thead", "tr", "th", "td", "tbody"])) }} 209 | ``` 210 | 211 | The `{% markdown %}` tag is recommended, as it avoids the need to `\"` escape quotes in your Markdown content. 212 | -------------------------------------------------------------------------------- /tests/test_render_markdown.py: -------------------------------------------------------------------------------- 1 | from datasette_render_markdown import render_cell, render_markdown, Markup 2 | from datasette.app import Datasette 3 | import pytest 4 | import textwrap 5 | 6 | 7 | @pytest.mark.parametrize("value", [1, 1.1, b"binary"]) 8 | def test_render_cell_not_str(value): 9 | assert ( 10 | render_cell( 11 | value, 12 | column="demo_markdown", 13 | table="mytable", 14 | database="mydatabase", 15 | datasette=Datasette([]), 16 | ) 17 | is None 18 | ) 19 | 20 | 21 | def test_render_cell_no_markdown_suffix(): 22 | assert ( 23 | render_cell( 24 | "# hello", 25 | column="no_suffix", 26 | table="mytable", 27 | database="mydatabase", 28 | datasette=Datasette([]), 29 | ) 30 | is None 31 | ) 32 | 33 | 34 | @pytest.mark.asyncio 35 | async def test_render_template_function(tmpdir): 36 | (tmpdir / "template.html").write_text( 37 | """ 38 | Demo: 39 | {{ render_markdown("* one") }} 40 | 41 | With a None: 42 | {{ render_markdown(None) }} 43 | Done. 44 | """.strip(), 45 | "utf-8", 46 | ) 47 | datasette = Datasette(template_dir=str(tmpdir)) 48 | await datasette.invoke_startup() 49 | rendered = await datasette.render_template(["template.html"]) 50 | assert rendered == ( 51 | "Demo:\n" 52 | '
\n\n" 55 | " With a None:\n" 56 | " \n" 57 | " Done." 58 | ) 59 | 60 | 61 | @pytest.mark.parametrize( 62 | "metadata", 63 | [ 64 | # Table level 65 | { 66 | "databases": { 67 | "mydatabase": { 68 | "tables": { 69 | "mytable": { 70 | "plugins": { 71 | "datasette-render-markdown": { 72 | "patterns": ["*_md"], 73 | } 74 | } 75 | } 76 | } 77 | } 78 | } 79 | }, 80 | # Database level 81 | { 82 | "databases": { 83 | "mydatabase": { 84 | "plugins": { 85 | "datasette-render-markdown": { 86 | "patterns": ["*_md"], 87 | } 88 | } 89 | } 90 | } 91 | }, 92 | # Global level 93 | { 94 | "plugins": { 95 | "datasette-render-markdown": { 96 | "patterns": ["*_md"], 97 | } 98 | } 99 | }, 100 | ], 101 | ) 102 | def test_render_markdown_metadata_patterns(metadata): 103 | expected = '

Hello there

\n
' 104 | input = "# Hello there\n* one\n*two\n*three" 105 | actual = render_cell( 106 | input, 107 | column="demo_md", 108 | table="mytable", 109 | database="mydatabase", 110 | datasette=Datasette(metadata=metadata), 111 | ) 112 | assert expected == actual 113 | # Without metadata should not render 114 | assert ( 115 | render_cell( 116 | input, 117 | column="demo_md", 118 | table="mytable", 119 | database="mydatabase", 120 | datasette=Datasette([]), 121 | ) 122 | is None 123 | ) 124 | 125 | 126 | def test_render_markdown_default_pattern(): 127 | expected = '

Hello there

\n
' 128 | input = "# Hello there\n* [one](https://www.example.com/)\n*two\n*three" 129 | actual = render_cell( 130 | input, 131 | column="demo_markdown", 132 | table="mytable", 133 | database="mydatabase", 134 | datasette=Datasette([]), 135 | ) 136 | assert expected == actual 137 | 138 | 139 | def test_render_markdown_default_pattern_disabled_if_empty_list(): 140 | input = "# Hello there\n* one\n*two\n*three" 141 | assert ( 142 | render_cell( 143 | input, 144 | column="demo_markdown", 145 | table="mytable", 146 | database="mydatabase", 147 | datasette=Datasette( 148 | metadata={"plugins": {"datasette-render-markdown": {"patterns": []}}} 149 | ), 150 | ) 151 | is None 152 | ) 153 | 154 | 155 | @pytest.mark.parametrize( 156 | "metadata", 157 | [ 158 | # Table level 159 | { 160 | "databases": { 161 | "mydatabase": { 162 | "tables": { 163 | "mytable": { 164 | "plugins": { 165 | "datasette-render-markdown": { 166 | "columns": ["body"], 167 | } 168 | } 169 | } 170 | } 171 | } 172 | } 173 | }, 174 | # Database level 175 | { 176 | "databases": { 177 | "mydatabase": { 178 | "plugins": { 179 | "datasette-render-markdown": { 180 | "columns": ["body"], 181 | } 182 | } 183 | } 184 | } 185 | }, 186 | # Global level 187 | { 188 | "plugins": { 189 | "datasette-render-markdown": { 190 | "columns": ["body"], 191 | } 192 | } 193 | }, 194 | ], 195 | ) 196 | def test_explicit_column(metadata): 197 | assert ( 198 | '

hello

' 199 | == render_cell( 200 | "*hello*", 201 | column="body", 202 | table="mytable", 203 | database="mydatabase", 204 | datasette=Datasette(metadata=metadata), 205 | ) 206 | ) 207 | 208 | 209 | @pytest.mark.parametrize( 210 | "input,expected", 211 | ( 212 | ("", '
'), 213 | ("# Heading", '

Heading

'), 214 | ( 215 | "![Alt text](https://www.example.com/blah.png)", 216 | '

Alt text

', 217 | ), 218 | ( 219 | "[This & That](https://www.example.com/)", 220 | ( 221 | '
' 222 | '

' 223 | "This & That

" 224 | ), 225 | ), 226 | (None, None), 227 | ), 228 | ) 229 | def test_miscellaneous_markup(input, expected): 230 | actual = render_cell( 231 | input, 232 | column="demo_markdown", 233 | table="mytable", 234 | database="mydatabase", 235 | datasette=Datasette([]), 236 | ) 237 | assert actual == expected 238 | 239 | 240 | MARKDOWN_TABLE = """ 241 | First Header | Second Header 242 | ------------- | ------------- 243 | [Content Cell](https://www.example.com/) | Content Cell 244 | Content Cell | Content Cell 245 | """.strip() 246 | 247 | RENDERED_TABLE = """ 248 |
249 | 250 | 251 | 252 | 253 | 254 | 255 | 256 | 257 | 258 | 259 | 260 | 261 | 262 | 263 | 264 | 265 |
First HeaderSecond Header
Content CellContent Cell
Content CellContent Cell
266 | """.strip() 267 | 268 | 269 | def test_extensions(): 270 | no_extension = render_cell( 271 | MARKDOWN_TABLE, 272 | column="body_markdown", 273 | table="mytable", 274 | database="mydatabase", 275 | datasette=Datasette([]), 276 | ) 277 | assert ( 278 | """ 279 |

First Header | Second Header 280 | ------------- | ------------- 281 | Content Cell | Content Cell 282 | Content Cell | Content Cell

283 | """.strip() 284 | == no_extension 285 | ) 286 | # Now try again with the tables extension 287 | with_extension = render_cell( 288 | MARKDOWN_TABLE, 289 | column="body_markdown", 290 | table="mytable", 291 | database="mydatabase", 292 | datasette=Datasette( 293 | [], 294 | metadata={ 295 | "plugins": { 296 | "datasette-render-markdown": { 297 | "extensions": ["tables"], 298 | "extra_tags": ["table", "thead", "tr", "th", "td", "tbody"], 299 | } 300 | } 301 | }, 302 | ), 303 | ) 304 | assert RENDERED_TABLE == with_extension 305 | 306 | 307 | @pytest.mark.asyncio 308 | async def test_render_template_function_with_extensions(tmpdir): 309 | (tmpdir / "template.html").write_text( 310 | '{{ render_markdown("""' 311 | + MARKDOWN_TABLE 312 | + '""", extensions=["tables"], extra_tags=["table", "thead", "tr", "th", "td", "tbody"]) }}', 313 | "utf-8", 314 | ) 315 | datasette = Datasette(template_dir=str(tmpdir)) 316 | await datasette.invoke_startup() 317 | rendered = await datasette.render_template(["template.html"]) 318 | assert RENDERED_TABLE == rendered 319 | 320 | 321 | def test_render_markdown_no_linkify_inside_code_blocks(): 322 | input = textwrap.dedent( 323 | """ 324 | # Heading 325 | 326 | Should be URLified: datasette.name 327 | 328 | Should not be URLified: 329 | 330 | select datasette.name from datasette 331 | """ 332 | ) 333 | output = render_markdown(input) 334 | assert output == Markup( 335 | '

Heading

\n' 336 | '

Should be URLified: datasette.name

\n' 337 | "

Should not be URLified:

\n" 338 | "
select datasette.name from datasette\n"
339 |         "
" 340 | ) 341 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------