Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
128 changes: 128 additions & 0 deletions document_page_markdown/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
.. image:: https://odoo-community.org/readme-banner-image
:target: https://odoo-community.org/get-involved?utm_source=readme
:alt: Odoo Community Association

======================
Document Page Markdown
======================

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:03227fb6b784d826d7804fc914b505749da16c52f32a998c93b3203ae085c341
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png
:target: https://odoo-community.org/page/development-status
:alt: Alpha
.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fknowledge-lightgray.png?logo=github
:target: https://github.com/OCA/knowledge/tree/16.0/document_page_markdown
:alt: OCA/knowledge
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/knowledge-16-0/knowledge-16-0-document_page_markdown
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/knowledge&target_branch=16.0
:alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This module adds a **Markdown** entry to the *Structure* section of the knowledge
page editor's ``/`` menu.

Picking it opens a *Write* / *Preview* box, the same way a pull request
description works: you write `Markdown
<https://daringfireball.net/projects/markdown/>`_, check the formatted result in
the preview, and insert it in the page as regular content.

The preview is rendered server side by the very same renderer that produces the
inserted content, so what you see is what you get.

.. IMPORTANT::
This is an alpha version, the data model and design can change at any time without warning.
Only for development or testing purpose, do not use in production.
`More details on development status <https://odoo-community.org/page/development-status>`_

**Table of contents**

.. contents::
:local:

Installation
============

This module requires the ``markdown`` Python library::

pip install markdown

Usage
=====

#. Go to *Knowledge > Pages* and open or create a page.
#. In the page content, type ``/`` and pick *Markdown* under *Structure*.
#. Write (or paste) Markdown in the *Write* tab. The toolbar inserts the syntax
for you if you prefer.
#. Check the result in the *Preview* tab.
#. Click *Insert*: the formatted content is added at the cursor, as regular page
content, so history, diffs and reports keep working as usual.

Known issues / Roadmap
======================

What is inserted is the rendered content, not the Markdown source: reopening the
page lets you edit it with the rich text editor, not as Markdown.

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/knowledge/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/knowledge/issues/new?body=module:%20document_page_markdown%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
~~~~~~~

* Escodoo

Contributors
~~~~~~~~~~~~

* `Escodoo <https://www.escodoo.com.br>`_:

* Cristiano Mafra Junior

Maintainers
~~~~~~~~~~~

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org

OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.

.. |maintainer-CristianoMafraJunior| image:: https://github.com/CristianoMafraJunior.png?size=40px
:target: https://github.com/CristianoMafraJunior
:alt: CristianoMafraJunior

Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-CristianoMafraJunior|

This module is part of the `OCA/knowledge <https://github.com/OCA/knowledge/tree/16.0/document_page_markdown>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
1 change: 1 addition & 0 deletions document_page_markdown/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import models
27 changes: 27 additions & 0 deletions document_page_markdown/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Copyright 2026 Escodoo
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).

{
"name": "Document Page Markdown",
"summary": "Insert Markdown written content in knowledge pages",
"version": "16.0.1.0.0",
"category": "Knowledge Management",
"author": "Escodoo, Odoo Community Association (OCA)",
"website": "https://github.com/OCA/knowledge",
"license": "AGPL-3",
"development_status": "Alpha",
"maintainers": ["CristianoMafraJunior"],
"depends": ["document_page"],
"external_dependencies": {"python": ["markdown"]},
"assets": {
"web.assets_backend": [
"document_page_markdown/static/src/js/markdown_dialog.esm.js",
"document_page_markdown/static/src/js/markdown_powerbox.esm.js",
"document_page_markdown/static/src/xml/markdown_dialog.xml",
"document_page_markdown/static/src/scss/markdown_dialog.scss",
],
"web.assets_tests": [
"document_page_markdown/static/tests/tours/markdown_powerbox_tour.esm.js",
],
},
}
1 change: 1 addition & 0 deletions document_page_markdown/models/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import document_page
21 changes: 21 additions & 0 deletions document_page_markdown/models/document_page.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Copyright 2026 Escodoo
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).

import markdown

from odoo import api, models

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
from odoo.tools import html_sanitize


class DocumentPage(models.Model):
_inherit = "document.page"

def _markdown_extensions(self):
"""Extensions passed to the renderer. Override to add your own."""
return ["extra", "sane_lists", "nl2br", "admonition"]

@api.model
def render_markdown(self, source):
"""Render a Markdown source into the HTML inserted in a page."""
if not source:
return ""
return markdown.markdown(source, extensions=self._markdown_extensions())

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
return markdown.markdown(source, extensions=self._markdown_extensions())
html = markdown.markdown(source, extensions=self._markdown_extensions())
return html_sanitize(html)

Python's markdown library allows raw HTML by default. Without html_sanitize(), someone pasting <script> or will execute arbitrary JavaScript in the preview dialog and in the page (Stored XSS).

3 changes: 3 additions & 0 deletions document_page_markdown/readme/CONTRIBUTORS.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
* `Escodoo <https://www.escodoo.com.br>`_:

* Cristiano Mafra Junior
10 changes: 10 additions & 0 deletions document_page_markdown/readme/DESCRIPTION.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
This module adds a **Markdown** entry to the *Structure* section of the knowledge
page editor's ``/`` menu.

Picking it opens a *Write* / *Preview* box, the same way a pull request
description works: you write `Markdown
<https://daringfireball.net/projects/markdown/>`_, check the formatted result in
the preview, and insert it in the page as regular content.

The preview is rendered server side by the very same renderer that produces the
inserted content, so what you see is what you get.
3 changes: 3 additions & 0 deletions document_page_markdown/readme/INSTALL.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
This module requires the ``markdown`` Python library::

pip install markdown
2 changes: 2 additions & 0 deletions document_page_markdown/readme/ROADMAP.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
What is inserted is the rendered content, not the Markdown source: reopening the
page lets you edit it with the rich text editor, not as Markdown.
7 changes: 7 additions & 0 deletions document_page_markdown/readme/USAGE.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#. Go to *Knowledge > Pages* and open or create a page.
#. In the page content, type ``/`` and pick *Markdown* under *Structure*.
#. Write (or paste) Markdown in the *Write* tab. The toolbar inserts the syntax
for you if you prefer.
#. Check the result in the *Preview* tab.
#. Click *Insert*: the formatted content is added at the cursor, as regular page
content, so history, diffs and reports keep working as usual.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading