From 0a740d6b87a01c419a14ef014567c12e64429fe7 Mon Sep 17 00:00:00 2001 From: CristianoMafraJunior Date: Mon, 19 Oct 2026 15:45:40 -0300 Subject: [PATCH] [ADD] document_page_markdown: add new module --- document_page_markdown/README.rst | 128 +++++ document_page_markdown/__init__.py | 1 + document_page_markdown/__manifest__.py | 27 + document_page_markdown/models/__init__.py | 1 + .../models/document_page.py | 21 + .../readme/CONTRIBUTORS.rst | 3 + document_page_markdown/readme/DESCRIPTION.rst | 10 + document_page_markdown/readme/INSTALL.rst | 3 + document_page_markdown/readme/ROADMAP.rst | 2 + document_page_markdown/readme/USAGE.rst | 7 + .../static/description/icon.png | Bin 0 -> 9455 bytes .../static/description/index.html | 473 ++++++++++++++++++ .../static/src/js/markdown_dialog.esm.js | 130 +++++ .../static/src/js/markdown_powerbox.esm.js | 56 +++ .../static/src/scss/markdown_dialog.scss | 39 ++ .../static/src/xml/markdown_dialog.xml | 66 +++ .../tests/tours/markdown_powerbox_tour.esm.js | 75 +++ document_page_markdown/tests/__init__.py | 2 + .../tests/test_document_page_markdown.py | 27 + .../tests/test_markdown_powerbox_tour.py | 27 + requirements.txt | 2 + .../odoo/addons/document_page_markdown | 1 + setup/document_page_markdown/setup.py | 6 + 23 files changed, 1107 insertions(+) create mode 100644 document_page_markdown/README.rst create mode 100644 document_page_markdown/__init__.py create mode 100644 document_page_markdown/__manifest__.py create mode 100644 document_page_markdown/models/__init__.py create mode 100644 document_page_markdown/models/document_page.py create mode 100644 document_page_markdown/readme/CONTRIBUTORS.rst create mode 100644 document_page_markdown/readme/DESCRIPTION.rst create mode 100644 document_page_markdown/readme/INSTALL.rst create mode 100644 document_page_markdown/readme/ROADMAP.rst create mode 100644 document_page_markdown/readme/USAGE.rst create mode 100644 document_page_markdown/static/description/icon.png create mode 100644 document_page_markdown/static/description/index.html create mode 100644 document_page_markdown/static/src/js/markdown_dialog.esm.js create mode 100644 document_page_markdown/static/src/js/markdown_powerbox.esm.js create mode 100644 document_page_markdown/static/src/scss/markdown_dialog.scss create mode 100644 document_page_markdown/static/src/xml/markdown_dialog.xml create mode 100644 document_page_markdown/static/tests/tours/markdown_powerbox_tour.esm.js create mode 100644 document_page_markdown/tests/__init__.py create mode 100644 document_page_markdown/tests/test_document_page_markdown.py create mode 100644 document_page_markdown/tests/test_markdown_powerbox_tour.py create mode 100644 requirements.txt create mode 120000 setup/document_page_markdown/odoo/addons/document_page_markdown create mode 100644 setup/document_page_markdown/setup.py diff --git a/document_page_markdown/README.rst b/document_page_markdown/README.rst new file mode 100644 index 00000000000..40c4073c039 --- /dev/null +++ b/document_page_markdown/README.rst @@ -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 +`_, 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 `_ + +**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 `_. +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 `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Escodoo + +Contributors +~~~~~~~~~~~~ + +* `Escodoo `_: + + * 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 `__: + +|maintainer-CristianoMafraJunior| + +This module is part of the `OCA/knowledge `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/document_page_markdown/__init__.py b/document_page_markdown/__init__.py new file mode 100644 index 00000000000..0650744f6bc --- /dev/null +++ b/document_page_markdown/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/document_page_markdown/__manifest__.py b/document_page_markdown/__manifest__.py new file mode 100644 index 00000000000..ee4f29f5d82 --- /dev/null +++ b/document_page_markdown/__manifest__.py @@ -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", + ], + }, +} diff --git a/document_page_markdown/models/__init__.py b/document_page_markdown/models/__init__.py new file mode 100644 index 00000000000..427be24e72a --- /dev/null +++ b/document_page_markdown/models/__init__.py @@ -0,0 +1 @@ +from . import document_page diff --git a/document_page_markdown/models/document_page.py b/document_page_markdown/models/document_page.py new file mode 100644 index 00000000000..56739afab17 --- /dev/null +++ b/document_page_markdown/models/document_page.py @@ -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 + + +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()) diff --git a/document_page_markdown/readme/CONTRIBUTORS.rst b/document_page_markdown/readme/CONTRIBUTORS.rst new file mode 100644 index 00000000000..e4d12da6c82 --- /dev/null +++ b/document_page_markdown/readme/CONTRIBUTORS.rst @@ -0,0 +1,3 @@ +* `Escodoo `_: + + * Cristiano Mafra Junior diff --git a/document_page_markdown/readme/DESCRIPTION.rst b/document_page_markdown/readme/DESCRIPTION.rst new file mode 100644 index 00000000000..e3cc62f819e --- /dev/null +++ b/document_page_markdown/readme/DESCRIPTION.rst @@ -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 +`_, 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. diff --git a/document_page_markdown/readme/INSTALL.rst b/document_page_markdown/readme/INSTALL.rst new file mode 100644 index 00000000000..eaf3efc42e4 --- /dev/null +++ b/document_page_markdown/readme/INSTALL.rst @@ -0,0 +1,3 @@ +This module requires the ``markdown`` Python library:: + + pip install markdown diff --git a/document_page_markdown/readme/ROADMAP.rst b/document_page_markdown/readme/ROADMAP.rst new file mode 100644 index 00000000000..860cc4b8cd8 --- /dev/null +++ b/document_page_markdown/readme/ROADMAP.rst @@ -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. diff --git a/document_page_markdown/readme/USAGE.rst b/document_page_markdown/readme/USAGE.rst new file mode 100644 index 00000000000..34ef9c72d31 --- /dev/null +++ b/document_page_markdown/readme/USAGE.rst @@ -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. diff --git a/document_page_markdown/static/description/icon.png b/document_page_markdown/static/description/icon.png new file mode 100644 index 0000000000000000000000000000000000000000..3a0328b516c4980e8e44cdb63fd945757ddd132d GIT binary patch literal 9455 zcmW++2RxMjAAjx~&dlBk9S+%}OXg)AGE&Cb*&}d0jUxM@u(PQx^-s)697TX`ehR4?GS^qbkof1cslKgkU)h65qZ9Oc=ml_0temigYLJfnz{IDzUf>bGs4N!v3=Z3jMq&A#7%rM5eQ#dc?k~! zVpnB`o+K7|Al`Q_U;eD$B zfJtP*jH`siUq~{KE)`jP2|#TUEFGRryE2`i0**z#*^6~AI|YzIWy$Cu#CSLW3q=GA z6`?GZymC;dCPk~rBS%eCb`5OLr;RUZ;D`}um=H)BfVIq%7VhiMr)_#G0N#zrNH|__ zc+blN2UAB0=617@>_u;MPHN;P;N#YoE=)R#i$k_`UAA>WWCcEVMh~L_ zj--gtp&|K1#58Yz*AHCTMziU1Jzt_jG0I@qAOHsk$2}yTmVkBp_eHuY$A9)>P6o~I z%aQ?!(GqeQ-Y+b0I(m9pwgi(IIZZzsbMv+9w{PFtd_<_(LA~0H(xz{=FhLB@(1&qHA5EJw1>>=%q2f&^X>IQ{!GJ4e9U z&KlB)z(84HmNgm2hg2C0>WM{E(DdPr+EeU_N@57;PC2&DmGFW_9kP&%?X4}+xWi)( z;)z%wI5>D4a*5XwD)P--sPkoY(a~WBw;E~AW`Yue4kFa^LM3X`8x|}ZUeMnqr}>kH zG%WWW>3ml$Yez?i%)2pbKPI7?5o?hydokgQyZsNEr{a|mLdt;X2TX(#B1j35xPnPW z*bMSSOauW>o;*=kO8ojw91VX!qoOQb)zHJ!odWB}d+*K?#sY_jqPdg{Sm2HdYzdEx zOGVPhVRTGPtv0o}RfVP;Nd(|CB)I;*t&QO8h zFfekr30S!-LHmV_Su-W+rEwYXJ^;6&3|L$mMC8*bQptyOo9;>Qb9Q9`ySe3%V$A*9 zeKEe+b0{#KWGp$F+tga)0RtI)nhMa-K@JS}2krK~n8vJ=Ngm?R!9G<~RyuU0d?nz# z-5EK$o(!F?hmX*2Yt6+coY`6jGbb7tF#6nHA zuKk=GGJ;ZwON1iAfG$E#Y7MnZVmrY|j0eVI(DN_MNFJmyZ|;w4tf@=CCDZ#5N_0K= z$;R~bbk?}TpfDjfB&aiQ$VA}s?P}xPERJG{kxk5~R`iRS(SK5d+Xs9swCozZISbnS zk!)I0>t=A<-^z(cmSFz3=jZ23u13X><0b)P)^1T_))Kr`e!-pb#q&J*Q`p+B6la%C zuVl&0duN<;uOsB3%T9Fp8t{ED108<+W(nOZd?gDnfNBC3>M8WE61$So|P zVvqH0SNtDTcsUdzaMDpT=Ty0pDHHNL@Z0w$Y`XO z2M-_r1S+GaH%pz#Uy0*w$Vdl=X=rQXEzO}d6J^R6zjM1u&c9vYLvLp?W7w(?np9x1 zE_0JSAJCPB%i7p*Wvg)pn5T`8k3-uR?*NT|J`eS#_#54p>!p(mLDvmc-3o0mX*mp_ zN*AeS<>#^-{S%W<*mz^!X$w_2dHWpcJ6^j64qFBft-o}o_Vx80o0>}Du;>kLts;$8 zC`7q$QI(dKYG`Wa8#wl@V4jVWBRGQ@1dr-hstpQL)Tl+aqVpGpbSfN>5i&QMXfiZ> zaA?T1VGe?rpQ@;+pkrVdd{klI&jVS@I5_iz!=UMpTsa~mBga?1r}aRBm1WS;TT*s0f0lY=JBl66Upy)-k4J}lh=P^8(SXk~0xW=T9v*B|gzIhN z>qsO7dFd~mgxAy4V?&)=5ieYq?zi?ZEoj)&2o)RLy=@hbCRcfT5jigwtQGE{L*8<@Yd{zg;CsL5mvzfDY}P-wos_6PfprFVaeqNE%h zKZhLtcQld;ZD+>=nqN~>GvROfueSzJD&BE*}XfU|H&(FssBqY=hPCt`d zH?@s2>I(|;fcW&YM6#V#!kUIP8$Nkdh0A(bEVj``-AAyYgwY~jB zT|I7Bf@%;7aL7Wf4dZ%VqF$eiaC38OV6oy3Z#TER2G+fOCd9Iaoy6aLYbPTN{XRPz z;U!V|vBf%H!}52L2gH_+j;`bTcQRXB+y9onc^wLm5wi3-Be}U>k_u>2Eg$=k!(l@I zcCg+flakT2Nej3i0yn+g+}%NYb?ta;R?(g5SnwsQ49U8Wng8d|{B+lyRcEDvR3+`O{zfmrmvFrL6acVP%yG98X zo&+VBg@px@i)%o?dG(`T;n*$S5*rnyiR#=wW}}GsAcfyQpE|>a{=$Hjg=-*_K;UtD z#z-)AXwSRY?OPefw^iI+ z)AXz#PfEjlwTes|_{sB?4(O@fg0AJ^g8gP}ex9Ucf*@_^J(s_5jJV}c)s$`Myn|Kd z$6>}#q^n{4vN@+Os$m7KV+`}c%4)4pv@06af4-x5#wj!KKb%caK{A&Y#Rfs z-po?Dcb1({W=6FKIUirH&(yg=*6aLCekcKwyfK^JN5{wcA3nhO(o}SK#!CINhI`-I z1)6&n7O&ZmyFMuNwvEic#IiOAwNkR=u5it{B9n2sAJV5pNhar=j5`*N!Na;c7g!l$ z3aYBqUkqqTJ=Re-;)s!EOeij=7SQZ3Hq}ZRds%IM*PtM$wV z@;rlc*NRK7i3y5BETSKuumEN`Xu_8GP1Ri=OKQ$@I^ko8>H6)4rjiG5{VBM>B|%`&&s^)jS|-_95&yc=GqjNo{zFkw%%HHhS~e=s zD#sfS+-?*t|J!+ozP6KvtOl!R)@@-z24}`9{QaVLD^9VCSR2b`b!KC#o;Ki<+wXB6 zx3&O0LOWcg4&rv4QG0)4yb}7BFSEg~=IR5#ZRj8kg}dS7_V&^%#Do==#`u zpy6{ox?jWuR(;pg+f@mT>#HGWHAJRRDDDv~@(IDw&R>9643kK#HN`!1vBJHnC+RM&yIh8{gG2q zA%e*U3|N0XSRa~oX-3EAneep)@{h2vvd3Xvy$7og(sayr@95+e6~Xvi1tUqnIxoIH zVWo*OwYElb#uyW{Imam6f2rGbjR!Y3`#gPqkv57dB6K^wRGxc9B(t|aYDGS=m$&S!NmCtrMMaUg(c zc2qC=2Z`EEFMW-me5B)24AqF*bV5Dr-M5ig(l-WPS%CgaPzs6p_gnCIvTJ=Y<6!gT zVt@AfYCzjjsMEGi=rDQHo0yc;HqoRNnNFeWZgcm?f;cp(6CNylj36DoL(?TS7eU#+ z7&mfr#y))+CJOXQKUMZ7QIdS9@#-}7y2K1{8)cCt0~-X0O!O?Qx#E4Og+;A2SjalQ zs7r?qn0H044=sDN$SRG$arw~n=+T_DNdSrarmu)V6@|?1-ZB#hRn`uilTGPJ@fqEy zGt(f0B+^JDP&f=r{#Y_wi#AVDf-y!RIXU^0jXsFpf>=Ji*TeqSY!H~AMbJdCGLhC) zn7Rx+sXw6uYj;WRYrLd^5IZq@6JI1C^YkgnedZEYy<&4(z%Q$5yv#Boo{AH8n$a zhb4Y3PWdr269&?V%uI$xMcUrMzl=;w<_nm*qr=c3Rl@i5wWB;e-`t7D&c-mcQl7x! zZWB`UGcw=Y2=}~wzrfLx=uet<;m3~=8I~ZRuzvMQUQdr+yTV|ATf1Uuomr__nDf=X zZ3WYJtHp_ri(}SQAPjv+Y+0=fH4krOP@S&=zZ-t1jW1o@}z;xk8 z(Nz1co&El^HK^NrhVHa-_;&88vTU>_J33=%{if;BEY*J#1n59=07jrGQ#IP>@u#3A z;!q+E1Rj3ZJ+!4bq9F8PXJ@yMgZL;>&gYA0%_Kbi8?S=XGM~dnQZQ!yBSgcZhY96H zrWnU;k)qy`rX&&xlDyA%(a1Hhi5CWkmg(`Gb%m(HKi-7Z!LKGRP_B8@`7&hdDy5n= z`OIxqxiVfX@OX1p(mQu>0Ai*v_cTMiw4qRt3~NBvr9oBy0)r>w3p~V0SCm=An6@3n)>@z!|o-$HvDK z|3D2ZMJkLE5loMKl6R^ez@Zz%S$&mbeoqH5`Bb){Ei21q&VP)hWS2tjShfFtGE+$z zzCR$P#uktu+#!w)cX!lWN1XU%K-r=s{|j?)Akf@q#3b#{6cZCuJ~gCxuMXRmI$nGtnH+-h z+GEi!*X=AP<|fG`1>MBdTb?28JYc=fGvAi2I<$B(rs$;eoJCyR6_bc~p!XR@O-+sD z=eH`-ye})I5ic1eL~TDmtfJ|8`0VJ*Yr=hNCd)G1p2MMz4C3^Mj?7;!w|Ly%JqmuW zlIEW^Ft%z?*|fpXda>Jr^1noFZEwFgVV%|*XhH@acv8rdGxeEX{M$(vG{Zw+x(ei@ zmfXb22}8-?Fi`vo-YVrTH*C?a8%M=Hv9MqVH7H^J$KsD?>!SFZ;ZsvnHr_gn=7acz z#W?0eCdVhVMWN12VV^$>WlQ?f;P^{(&pYTops|btm6aj>_Uz+hqpGwB)vWp0Cf5y< zft8-je~nn?W11plq}N)4A{l8I7$!ks_x$PXW-2XaRFswX_BnF{R#6YIwMhAgd5F9X zGmwdadS6(a^fjHtXg8=l?Rc0Sm%hk6E9!5cLVloEy4eh(=FwgP`)~I^5~pBEWo+F6 zSf2ncyMurJN91#cJTy_u8Y}@%!bq1RkGC~-bV@SXRd4F{R-*V`bS+6;W5vZ(&+I<9$;-V|eNfLa5n-6% z2(}&uGRF;p92eS*sE*oR$@pexaqr*meB)VhmIg@h{uzkk$9~qh#cHhw#>O%)b@+(| z^IQgqzuj~Sk(J;swEM-3TrJAPCq9k^^^`q{IItKBRXYe}e0Tdr=Huf7da3$l4PdpwWDop%^}n;dD#K4s#DYA8SHZ z&1!riV4W4R7R#C))JH1~axJ)RYnM$$lIR%6fIVA@zV{XVyx}C+a-Dt8Y9M)^KU0+H zR4IUb2CJ{Hg>CuaXtD50jB(_Tcx=Z$^WYu2u5kubqmwp%drJ6 z?Fo40g!Qd<-l=TQxqHEOuPX0;^z7iX?Ke^a%XT<13TA^5`4Xcw6D@Ur&VT&CUe0d} z1GjOVF1^L@>O)l@?bD~$wzgf(nxX1OGD8fEV?TdJcZc2KoUe|oP1#=$$7ee|xbY)A zDZq+cuTpc(fFdj^=!;{k03C69lMQ(|>uhRfRu%+!k&YOi-3|1QKB z z?n?eq1XP>p-IM$Z^C;2L3itnbJZAip*Zo0aw2bs8@(s^~*8T9go!%dHcAz2lM;`yp zD=7&xjFV$S&5uDaiScyD?B-i1ze`+CoRtz`Wn+Zl&#s4&}MO{@N!ufrzjG$B79)Y2d3tBk&)TxUTw@QS0TEL_?njX|@vq?Uz(nBFK5Pq7*xj#u*R&i|?7+6# z+|r_n#SW&LXhtheZdah{ZVoqwyT{D>MC3nkFF#N)xLi{p7J1jXlmVeb;cP5?e(=f# zuT7fvjSbjS781v?7{)-X3*?>tq?)Yd)~|1{BDS(pqC zC}~H#WXlkUW*H5CDOo<)#x7%RY)A;ShGhI5s*#cRDA8YgqG(HeKDx+#(ZQ?386dv! zlXCO)w91~Vw4AmOcATuV653fa9R$fyK8ul%rG z-wfS zihugoZyr38Im?Zuh6@RcF~t1anQu7>#lPpb#}4cOA!EM11`%f*07RqOVkmX{p~KJ9 z^zP;K#|)$`^Rb{rnHGH{~>1(fawV0*Z#)}M`m8-?ZJV<+e}s9wE# z)l&az?w^5{)`S(%MRzxdNqrs1n*-=jS^_jqE*5XDrA0+VE`5^*p3CuM<&dZEeCjoz zR;uu_H9ZPZV|fQq`Cyw4nscrVwi!fE6ciMmX$!_hN7uF;jjKG)d2@aC4ropY)8etW=xJvni)8eHi`H$%#zn^WJ5NLc-rqk|u&&4Z6fD_m&JfSI1Bvb?b<*n&sfl0^t z=HnmRl`XrFvMKB%9}>PaA`m-fK6a0(8=qPkWS5bb4=v?XcWi&hRY?O5HdulRi4?fN zlsJ*N-0Qw+Yic@s0(2uy%F@ib;GjXt01Fmx5XbRo6+n|pP(&nodMoap^z{~q ziEeaUT@Mxe3vJSfI6?uLND(CNr=#^W<1b}jzW58bIfyWTDle$mmS(|x-0|2UlX+9k zQ^EX7Nw}?EzVoBfT(-LT|=9N@^hcn-_p&sqG z&*oVs2JSU+N4ZD`FhCAWaS;>|wH2G*Id|?pa#@>tyxX`+4HyIArWDvVrX)2WAOQff z0qyHu&-S@i^MS-+j--!pr4fPBj~_8({~e1bfcl0wI1kaoN>mJL6KUPQm5N7lB(ui1 zE-o%kq)&djzWJ}ob<-GfDlkB;F31j-VHKvQUGQ3sp`CwyGJk_i!y^sD0fqC@$9|jO zOqN!r!8-p==F@ZVP=U$qSpY(gQ0)59P1&t@y?5rvg<}E+GB}26NYPp4f2YFQrQtot5mn3wu_qprZ=>Ig-$ zbW26Ws~IgY>}^5w`vTB(G`PTZaDiGBo5o(tp)qli|NeV( z@H_=R8V39rt5J5YB2Ky?4eJJ#b`_iBe2ot~6%7mLt5t8Vwi^Jy7|jWXqa3amOIoRb zOr}WVFP--DsS`1WpN%~)t3R!arKF^Q$e12KEqU36AWwnCBICpH4XCsfnyrHr>$I$4 z!DpKX$OKLWarN7nv@!uIA+~RNO)l$$w}p(;b>mx8pwYvu;dD_unryX_NhT8*Tj>BTrTTL&!?O+%Rv;b?B??gSzdp?6Uug9{ zd@V08Z$BdI?fpoCS$)t4mg4rT8Q_I}h`0d-vYZ^|dOB*Q^S|xqTV*vIg?@fVFSmMpaw0qtTRbx} z({Pg?#{2`sc9)M5N$*N|4;^t$+QP?#mov zGVC@I*lBVrOU-%2y!7%)fAKjpEFsgQc4{amtiHb95KQEwvf<(3T<9-Zm$xIew#P22 zc2Ix|App^>v6(3L_MCU0d3W##AB0M~3D00EWoKZqsJYT(#@w$Y_H7G22M~ApVFTRHMI_3be)Lkn#0F*V8Pq zc}`Cjy$bE;FJ6H7p=0y#R>`}-m4(0F>%@P|?7fx{=R^uFdISRnZ2W_xQhD{YuR3t< z{6yxu=4~JkeA;|(J6_nv#>Nvs&FuLA&PW^he@t(UwFFE8)|a!R{`E`K`i^ZnyE4$k z;(749Ix|oi$c3QbEJ3b~D_kQsPz~fIUKym($a_7dJ?o+40*OLl^{=&oq$<#Q(yyrp z{J-FAniyAw9tPbe&IhQ|a`DqFTVQGQ&Gq3!C2==4x{6EJwiPZ8zub-iXoUtkJiG{} zPaR&}_fn8_z~(=;5lD-aPWD3z8PZS@AaUiomF!G8I}Mf>e~0g#BelA-5#`cj;O5>N Xviia!U7SGha1wx#SCgwmn*{w2TRX*I literal 0 HcmV?d00001 diff --git a/document_page_markdown/static/description/index.html b/document_page_markdown/static/description/index.html new file mode 100644 index 00000000000..7b73f698b33 --- /dev/null +++ b/document_page_markdown/static/description/index.html @@ -0,0 +1,473 @@ + + + + + +README.rst + + + +
+ + + +Odoo Community Association + +
+

Document Page Markdown

+ +

Alpha License: AGPL-3 OCA/knowledge Translate me on Weblate Try me on Runboat

+

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, 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

+
+

Table of contents

+ +
+

Installation

+

This module requires the markdown Python library:

+
+pip install markdown
+
+
+
+

Usage

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

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. +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.

+

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

+
+
+

Credits

+
+

Authors

+
    +
  • Escodoo
    • +
+
+
+

Contributors

+
    +
  • Escodoo:
      +
    • Cristiano Mafra Junior
      • +
    +
    • +
+
+
+

Maintainers

+

This module is maintained by the OCA.

+ +Odoo Community Association + +

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.

+

Current maintainer:

+

CristianoMafraJunior

+

This module is part of the OCA/knowledge project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+
+ + diff --git a/document_page_markdown/static/src/js/markdown_dialog.esm.js b/document_page_markdown/static/src/js/markdown_dialog.esm.js new file mode 100644 index 00000000000..de2734ca7a4 --- /dev/null +++ b/document_page_markdown/static/src/js/markdown_dialog.esm.js @@ -0,0 +1,130 @@ +/** @odoo-module **/ + +import {Component, markup, useRef, useState, xml} from "@odoo/owl"; +import {Dialog} from "@web/core/dialog/dialog"; +import {_lt} from "@web/core/l10n/translation"; +import {useService} from "@web/core/utils/hooks"; +import {useWowlService} from "@web/legacy/utils"; + +const TOOLBAR_COMMANDS = [ + {name: "h1", icon: "fa-header", title: _lt("Heading"), prefix: "# "}, + {name: "h2", icon: "fa-header fa-sm", title: _lt("Subheading"), prefix: "## "}, + {name: "bold", icon: "fa-bold", title: _lt("Bold"), wrap: "**"}, + {name: "italic", icon: "fa-italic", title: _lt("Italic"), wrap: "*"}, + {name: "strike", icon: "fa-strikethrough", title: _lt("Strikethrough"), wrap: "~~"}, + {name: "code", icon: "fa-code", title: _lt("Code"), wrap: "`"}, + {name: "quote", icon: "fa-quote-right", title: _lt("Quote"), prefix: "> "}, + {name: "ul", icon: "fa-list-ul", title: _lt("Bulleted list"), prefix: "- "}, + {name: "ol", icon: "fa-list-ol", title: _lt("Numbered list"), prefix: "1. "}, + { + name: "check", + icon: "fa-check-square-o", + title: _lt("Checklist"), + prefix: "- [ ] ", + }, + {name: "link", icon: "fa-link", title: _lt("Link"), template: "[$1](https://)"}, + { + name: "table", + icon: "fa-table", + title: _lt("Table"), + block: "| A | B |\n| --- | --- |\n| | |", + }, + {name: "hr", icon: "fa-minus", title: _lt("Separator"), block: "---"}, +]; + +/** + * Write Markdown, preview it, and insert it as rich content. + */ +export class MarkdownDialog extends Component { + setup() { + this.orm = useService("orm"); + this.textareaRef = useRef("textarea"); + this.toolbar = TOOLBAR_COMMANDS; + this.state = useState({source: "", preview: "", previewing: false}); + } + + /** + * Apply a toolbar command on the current selection. + * + * @param {Object} command One of the entries of `TOOLBAR_COMMANDS`. + */ + applyCommand(command) { + const textarea = this.textareaRef.el; + const value = textarea.value; + let start = textarea.selectionStart; + let end = textarea.selectionEnd; + if (command.prefix) { + // Line commands apply to the whole line(s) the cursor is on. + start = value.lastIndexOf("\n", start - 1) + 1; + const nextBreak = value.indexOf("\n", end); + end = nextBreak === -1 ? value.length : nextBreak; + } + const selection = value.slice(start, end); + let replacement = selection; + if (command.wrap) { + replacement = `${command.wrap}${selection}${command.wrap}`; + } else if (command.prefix) { + replacement = selection + .split("\n") + .map((line) => `${command.prefix}${line}`) + .join("\n"); + } else if (command.template) { + replacement = command.template.replace("$1", selection || _lt("label")); + } else if (command.block) { + const lineBreak = start === 0 || value[start - 1] === "\n" ? "" : "\n"; + replacement = `${lineBreak}${command.block}\n`; + } + textarea.value = value.slice(0, start) + replacement + value.slice(end); + textarea.focus(); + const cursor = start + replacement.length; + textarea.setSelectionRange(cursor, cursor); + this.state.source = textarea.value; + } + + onInput(ev) { + this.state.source = ev.target.value; + } + + /** + * Switch between the "Write" and "Preview" tabs. + * + * @param {Boolean} previewing + */ + async showTab(previewing) { + this.state.previewing = previewing; + if (previewing) { + this.state.preview = markup(await this.renderMarkdown()); + } + } + + renderMarkdown() { + return this.orm.call("document.page", "render_markdown", [this.state.source]); + } + + async onInsert() { + if (this.state.source) { + this.props.insert(await this.renderMarkdown()); + } + this.props.close(); + } +} + +MarkdownDialog.template = "document_page_markdown.MarkdownDialog"; +MarkdownDialog.components = {Dialog}; +MarkdownDialog.props = { + insert: Function, + // Injected by the dialog service. + close: Function, +}; + +/** + * Mountable wrapper, so the legacy wysiwyg widget can open the dialog. + */ +export class MarkdownDialogWrapper extends Component { + setup() { + useWowlService("dialog").add(MarkdownDialog, this.props); + } +} + +MarkdownDialogWrapper.template = xml``; +MarkdownDialogWrapper.props = {insert: Function}; diff --git a/document_page_markdown/static/src/js/markdown_powerbox.esm.js b/document_page_markdown/static/src/js/markdown_powerbox.esm.js new file mode 100644 index 00000000000..3b7329407a0 --- /dev/null +++ b/document_page_markdown/static/src/js/markdown_powerbox.esm.js @@ -0,0 +1,56 @@ +/** @odoo-module **/ + +import { + parseHTML, + preserveCursor, +} from "@web_editor/js/editor/odoo-editor/src/utils/utils"; +import {ComponentWrapper} from "web.OwlCompatibility"; +import {MarkdownDialogWrapper} from "@document_page_markdown/js/markdown_dialog.esm"; +import Wysiwyg from "web_editor.wysiwyg"; +import core from "web.core"; + +const _t = core._t; + +/** + * Add a "Markdown" entry to the editor's "/" powerbox, on knowledge pages. + */ +Wysiwyg.include({ + /** + * @override + */ + _getPowerboxOptions: function () { + const options = this._super(...arguments); + if (this.options.recordInfo.res_model !== "document.page") { + return options; + } + options.commands.push({ + category: _t("Structure"), + name: _t("Markdown"), + priority: 25, + description: _t("Write Markdown and insert it as content."), + fontawesome: "fa-file-code-o", + isDisabled: () => !this.odooEditor.isSelectionInBlockRoot(), + callback: () => this._openMarkdownDialog(), + }); + return options; + }, + + /** + * Ask for a Markdown source and insert its rendering at the cursor. + * + * @private + * @returns {Promise} resolved once the dialog is mounted + */ + _openMarkdownDialog: function () { + // Clicking in the dialog loses the selection inside the editable, so + // it has to be restored before inserting anything. + const restoreSelection = preserveCursor(this.odooEditor.document); + const wrapper = new ComponentWrapper(this, MarkdownDialogWrapper, { + insert: (html) => { + restoreSelection(); + this.odooEditor.execCommand("insert", parseHTML(html)); + }, + }); + return wrapper.mount(document.body); + }, +}); diff --git a/document_page_markdown/static/src/scss/markdown_dialog.scss b/document_page_markdown/static/src/scss/markdown_dialog.scss new file mode 100644 index 00000000000..663b97500a6 --- /dev/null +++ b/document_page_markdown/static/src/scss/markdown_dialog.scss @@ -0,0 +1,39 @@ +.o_markdown_dialog { + .o_markdown_tabs { + margin-bottom: 0; + } + + .o_markdown_body { + border: 1px solid $border-color; + border-top: 0; + border-radius: 0 0 $border-radius $border-radius; + padding: 8px; + min-height: 320px; + } + + .o_markdown_toolbar { + border-bottom: 1px solid $border-color; + margin-bottom: 8px; + padding-bottom: 4px; + } + + .o_markdown_source { + width: 100%; + min-height: 280px; + resize: vertical; + font-family: $font-family-monospace; + font-size: 0.9em; + white-space: pre; + overflow-wrap: normal; + overflow-x: auto; + } + + .o_markdown_preview { + overflow-x: auto; + + table { + @extend .table, .table-bordered; + width: auto; + } + } +} diff --git a/document_page_markdown/static/src/xml/markdown_dialog.xml b/document_page_markdown/static/src/xml/markdown_dialog.xml new file mode 100644 index 00000000000..fc79bcb3d4c --- /dev/null +++ b/document_page_markdown/static/src/xml/markdown_dialog.xml @@ -0,0 +1,66 @@ + + + + +
+ +
+
+ +
+