adding txt2tags-it: support to txt2tags syntax in addition to md by luginf · Pull Request #282 · qownnotes/scripts

luginf · 2026-04-11T21:23:58Z

No description provided.

…kdown one

Copilot

Pull request overview

Adds a new QOwnNotes script (txt2tags-it) that extends the existing markdown-it based renderer to also understand a subset of txt2tags syntax in both preview rendering and editor highlighting.

Changes:

Introduces a new txt2tags-it renderer script that wires a txt2tags markdown-it plugin and optional editor highlighting rules.
Adds a new markdown-it plugin (markdown-it-txt2tags.js) implementing txt2tags-style headings/comments/lists and inline formatting.
Bundles required markdown-it-related JS resources and adds script metadata/docs.

Reviewed changes

Copilot reviewed 5 out of 7 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
txt2tags-it/txt2tags-it.qml	New renderer script integrating markdown-it + optional deflist/KaTeX + txt2tags plugin + editor highlighting rules.
txt2tags-it/markdown-it-txt2tags.js	New markdown-it plugin implementing txt2tags syntax features.
txt2tags-it/markdown-it-deflist.js	Bundled definition list plugin dependency for markdown-it.
txt2tags-it/info.json	Script metadata/resources list for QOwnNotes script loader.
txt2tags-it/README.md	Minimal documentation for the new script.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-12T05:34:00Z

+  "version": "1.5",
+  "minAppVersion": "20.6.0",
+  "description": "This script replaces the default markdown renderer with markdown-it and allows for optional LaTeX rendering support with the Markdown-It KaTeX plugin. (NOTE: LaTeX defaults to rendering with MathML ONLY). \n\n<b>Dependencies</b>\n<a href=\"https://github.com/markdown-it/markdown-it\">markdown-it.js</a> (v8.4.2 bundled with the script)\n<a href=\"https://github.com/mdit-plugins/mdit-plugins/tree/main/packages/katex\">Markdown-It KaTeX plugin</a> (v0.18.0 bundled with the script)\n\n<b>Usage</b>\nFor the possible configuration options check <a href=\"https://github.com/markdown-it/markdown-it/tree/main/lib/presets\">here</a>.\n\n<b>Important</b>\nThis script currently only works with <a href=\"https://github.com/qownnotes/scripts/issues/77\"><b>legacy media links</b></a>. You can turn them on in the <i>General Settings</i>.\n\nImportant note: You need to use legacy image linking with this script, otherwise there will be no images shown in the preview!"
+}


info.json’s description still describes only the markdown-it + KaTeX renderer and doesn’t mention the new txt2tags syntax support that this script adds. This is inconsistent with the script’s purpose/title and will confuse users browsing available scripts. Update the description to include txt2tags support (and any constraints, e.g. which txt2tags features are implemented).

Copilot · 2026-04-12T05:34:01Z

+                finalPath = rawPath.replace(/\\/g, '/');
+            else
+                // Relative path → resolve against base
+                finalPath = resolvePath(basePath, rawPath.replace(/^\.\/+/, ''));


resolvePath(basePath, ...) references basePath, but no such variable is defined in this function (the computed base directory is stored in path). This will throw at runtime when a relative src/href is encountered, breaking preview/export rendering. Pass the correct base variable (likely path) into resolvePath (or rename consistently).

Suggested change

finalPath = resolvePath(basePath, rawPath.replace(/^\.\/+/, ''));

finalPath = resolvePath(path, rawPath.replace(/^\.\/+/, ''));

Copilot · 2026-04-12T05:34:01Z

+        mdHtml = mdHtml.replace(/(\b(?:src|href|data-[\w-]+)\s*=\s*["'])([^"']+)["']/gi, (_, prefix, rawPath) => {
+            // Convert backslashes to forward slashes for URL
+
+            if (isProtocolUrl(rawPath))
+                return `${prefix}${rawPath}"`;


The URL rewrite returns strings that always end with a double quote (e.g. return `${prefix}${rawPath}"`;). Since the match can start with either ' or ", this can generate malformed HTML when the original attribute used single quotes. Capture/reuse the original quote character in the replacement.

I guess that needs fixing, @luginf.

@pbek fixed in next commit

Example of the bug:

Original HTML: src='image.png'

Produced result: src='file:///path/image.png" ← malformed

Fix: capture the quote character in a separate group and reuse it as the closing quote.

What changed:

The regex now splits attr (e.g. src=) and quote (the " or ' character) into two separate groups, and \2
ensures the closing quote matches the opening one.

Both return statements use ${quote} to open and close — the HTML stays well-formed.

Copilot · 2026-04-12T05:34:01Z

+                finalPath = resolvePath(basePath, rawPath.replace(/^\.\/+/, ''));
+            return `${prefix}file://${finalPath}"`;
+        });


Same quoting issue here: return `${prefix}file://${finalPath}"`; always emits a double quote regardless of whether the original attribute used ' or ". Reuse the original quote character (e.g. by capturing it) to avoid producing invalid HTML.

It guess that needs fixing, @luginf.

It guess that needs fixing, @luginf.

done as well

Copilot · 2026-04-12T05:34:01Z

+        {
+            "identifier": "useKatexPlugin",
+            "name": "LaTeX Support",
+            "text": "Enable the Markdown-it definition list KaTeX plugin",


The useKatexPlugin setting text says "Enable the Markdown-it definition list KaTeX plugin", which is misleading (it’s not related to definition lists). Update the label to accurately describe enabling KaTeX/LaTeX rendering.

Suggested change

"text": "Enable the Markdown-it definition list KaTeX plugin",

"text": "Enable the Markdown-it KaTeX / LaTeX rendering plugin",

@luginf, what should the correct text be?

@luginf, what should the correct text be?

I've removed it since then (also the option)

@luginf, what should the correct text be?

the option has been removed since then

luginf · 2026-04-12T08:58:18Z

@pbek

I've worked more on it for better support of some links but it broke elsewhere, I'll post more soon.

I'll also check if it's possible to have it compatible with QT6, because your AppImage doesn't work with this script, while my QT5 build is working correctly.

pbek · 2026-04-12T12:09:49Z

because your AppImage doesn't work with this script, while my QT5 build is working correctly.

What is happening?

luginf · 2026-04-13T09:40:20Z

because your AppImage doesn't work with this script, while my QT5 build is working correctly.

What is happening?

it just shows the txt2tags syntax but without styling it, here is a screenshot, QT5 on the left, QT6 on the right:

(numbered list is still wrong at the moment, I'll fix that soon)

pbek · 2026-04-13T13:27:32Z

Could you please post the first block of the settings dump of the Qt6 appimage and the same for your build?

- Enable html:true by default so HTML comments () are passed through as-is instead of being escaped as visible text - Fix --strikethrough-- to use <s> tag instead of <del>, consistent with markdown ~~strikethrough~~ rendering - Remove + item ordered list editor highlighting rule (was applying an unwanted heading style to list lines) - Fix basePath undefined variable → path in relative URL resolution - Register txt2tags_link before adding autolink/wikilink rules: ruler.before("txt2tags_link", ...) threw "Parser rule not found" when called before txt2tags_link was itself registered, aborting the entire plugin initialisation and breaking all txt2tags rendering Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

luginf · 2026-04-14T20:21:36Z

Could you please post the first block of the settings dump of the Qt6 appimage and the same for your build?

both use the same configuration file and scripts

Qt6:

General Info

Current Date: Tue Apr 14 21:37:32 2026
Version: 26.4.12
Build date: Apr 13 2026
Build number: 1311
Platform: linux (xcb)
Operating System: Linux Mint 22.2
Build architecture: x86_64
Current architecture: x86_64
Release: AppImage
Qt Version (build): 6.10.2
Qt Version (runtime): 6.10.2
Portable mode: no
Settings path / key: /home/eric/.config/PBE/QOwnNotes.conf
Application database path: /home/eric/.local/share/PBE/QOwnNotes/QOwnNotes.sqlite
Application arguments: /tmp/.mount_QOwnNoBUfHWZ/AppRun.wrapped
Qt Debug: no
System Botan: no
Libgit2: no
QLiteHtml: yes
Locale (system): fr_FR
Locale (interface): fr
Primary screen resolution: 1920x1080
Screen resolution(s): 1920x1080, 1280x1024
Icon theme: Adwaita
Notes in current note folder: 97
Calendar items: 0
Enabled scripts: 3
Database drivers: QSQLITE

Server Info

serverUrl: empty
appIsValid: yes
notesPathExists: empty
serverVersion: empty
appVersion: empty

/.../

Script `txt2tags-it`

id: 2
path: /home/eric/ownCloud/en_cours/qownnotes/txt2tags-it/txt2tags-it.qml

Qt5

General Info

Current Date: mar. avr. 14 21:39:11 2026
Version: 26.4.11
Build date: Apr 12 2026
Build number: 1310
Platform: linux (xcb)
Operating System: Linux Mint 22.2
Build architecture: x86_64
Current architecture: x86_64
Release: Self-build
Qt Version (build): 5.15.13
Qt Version (runtime): 5.15.13
Portable mode: no
Settings path / key: /home/eric/.config/PBE/QOwnNotes.conf
Application database path: /home/eric/.local/share/PBE/QOwnNotes/QOwnNotes.sqlite
Application arguments: QOwnNotes
Qt Debug: no
System Botan: no
Libgit2: no
QLiteHtml: no
Locale (system): fr_FR
Locale (interface): fr
Primary screen resolution: 1920x1080
Screen resolution(s): 1920x1080, 1280x1024
Icon theme: Mint-L-Teal
Notes in current note folder: 97
Calendar items: 0
Enabled scripts: 3
Database drivers: QSQLITE, QMARIADB, QMYSQL, QMYSQL3

/.../

Script `txt2tags-it`

id: 2
path: /home/eric/ownCloud/en_cours/qownnotes/txt2tags-it/txt2tags-it.qml

It's maybe related to QtQml.

There is an error when starting the appimage:

Warning: file:///home/eric/ownCloud/en_cours/qownnotes/txt2tags-it/txt2tags-it.qml:123: TypeError: Cannot call method 'render' of undefined (file:///home/eric/ownCloud/en_cours/qownnotes/txt2tags-it/txt2tags-it.qml:123, (null))

the code is

var mdHtml = md.render(note.noteText);

and it's also in the markdown-it script, which also raises the same warning:

Warning: file:///home/eric/.local/share/PBE/QOwnNotes/scripts/markdown-it/markdown-it.qml:87: TypeError: Cannot call method 'render' of undefined (file:///home/eric/.local/share/PBE/QOwnNotes/scripts/markdown-it/markdown-it.qml:87, (null))

…namespace In Qt5, importing a JS file in QML binds the module's top-level `this` to the QML global scope, so UMD modules export their constructors onto the component via `g = this; g.markdownit = f()`, and `this.markdownit` works in init(). In Qt6, the module's top-level `this` is the module namespace object (e.g. MarkdownIt, MarkdownItTxt2tags), not the QML component scope. So the constructors land on `MarkdownIt.markdownit` etc., and `this.markdownit` in init() is undefined — causing silent init failure and a blank preview. Fix: resolve each constructor with `Namespace.name || this.name` so that Qt6 uses the module namespace and Qt5 falls back to the component scope. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

In Qt6 QML, JavaScript files imported via 'import "foo.js" as Foo' run in strict mode where `this` at the top level is undefined. The UMD wrappers in markdown-it, markdown-it-deflist, markdown-it-katex and markdown-it-txt2tags all fell back to `g = this` when window/global/self were undefined, then threw TypeError setting a property on undefined. Fix: insert `globalThis` before the `this` fallback in each UMD chain. globalThis is always the real global object in Qt6's JS engine. In init(), resolve constructors via `_g = globalThis || this` so that Qt6 uses globalThis (where the modules now export) and Qt5 falls back to the component scope (where the modules previously exported via this). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

The root cause of Qt6 breakage: UMD modules used `g = this; g.markdownit = f()` where `this` at module top-level is undefined in Qt6 strict mode, so the assignment threw and nothing was exported. Fix: declare `var markdownit` and `var markdownitTxt2tags` at the top level of each JS file (outside the IIFE). Top-level vars are always accessible via the QML module qualifier (MarkdownIt.markdownit, MarkdownItTxt2tags.markdownitTxt2tags) in both Qt5 and Qt6 — no runtime this/globalThis lookup needed. Also removed the unused deflist and katex plugins to simplify the script. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

luginf · 2026-04-14T23:36:19Z

@pbek it is working now for both Qt5 (my compiled binary) and Qt6 (your AppImage)!

luginf · 2026-04-15T00:24:43Z

I also needed to have the custom heading syntax detected into the "Headings panel", but it looks like it require to be changed in the source code, so I've used this in a fork:

pbek/QOwnNotes@main...luginf:QOwnNotes-t2t:main

Maybe it's possible to do it differently?

pbek · 2026-04-15T07:16:01Z

@pbek it is working now for both Qt5 (my compiled binary) and Qt6 (your AppImage)!

Awesome. Your Qt5 version of QOwnNotes did not have QLiteHtml, that could explain the difference.

I also needed to have the custom heading syntax detected into the "Headings panel", but it looks like it require to be changed in the source code, so I've used this in a fork:

That looks like something that is just needed for your script. What was it you were trying to achieve? Is there a minimal script custom highlighting you can offer to test it?

luginf · 2026-04-15T09:04:17Z

That looks like something that is just needed for your script. What was it you were trying to achieve?

Yeah, I don't know. I just wanted to be able to change the heading panel content without modifying the qownnotes code, but the LLM answered:

The scripting API's addHighlightingRule() could already receive a state, but that state was never applied to the block.

recap: We're making txt2tags headings appear in QOwnNotes' navigation panel. The fix is ready as two generic commits in the fork — the next step is to open a PR to pbek/QOwnNotes with the highlightScriptingRules() change.

Is there a minimal script custom highlighting you can offer to test it?

in attachement:
test-addHighlightingRule.zip

it's basically:

QtObject {
    function init() {
        // H1: @ Heading 1 @   (state 12 = MarkdownHighlighter::H1)
        script.addHighlightingRule("^@ +.+? +@\\s*$",     "@",  12);
        // H2: @@ Heading 2 @@ (state 13 = MarkdownHighlighter::H2)
        script.addHighlightingRule("^@@ +.+? +@@\\s*$",   "@@", 13);
        // H3: @@@ Heading 3 @@@ (state 14 = MarkdownHighlighter::H3)
        script.addHighlightingRule("^@@@ +.+? +@@@\\s*$", "@@@", 14);
    }
}

with a fictional syntax like @@ heading level 2 @@ it would work. It would also work for editing mediawiki, dokuwiki or any other lightweight markup langage

pbek · 2026-04-15T11:53:41Z

I will implement something in the next release to support the headings from addHighlightingRule in the navigation panel.

luginf · 2026-04-15T14:20:39Z

I will implement something in the next release to support the headings from addHighlightingRule in the navigation panel.

thank you very much!

… (# is default)

luginf · 2026-04-15T16:09:20Z

the other commit for in-note-text-tagging is appearing in this one as well, I should have done a new branch :/

pbek · 2026-04-15T19:00:12Z

the other commit for in-note-text-tagging is appearing in this one as well, I should have done a new branch :/

Can you please put those changes to another PR?

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

luginf · 2026-04-16T12:32:10Z

the other commit for in-note-text-tagging is appearing in this one as well, I should have done a new branch :/

Can you please put those changes to another PR?

I've done that, but I'm not sure it worked correctly...

pbek · 2026-04-16T12:38:53Z

No, you need to cherry-pick the commits you want to get into this PR. Also, you created a PR from your main branch, which is generally a very bad idea, since every time you update your main branch from the upstream one you will also modify your PR. You should create a new branch from a clean upstream main branch and then put your script there and create a clean commit. You need a new PR of course. But I would have squashed your tons of commits anyway in this PR.

luginf · 2026-04-17T06:28:27Z

No, you need to cherry-pick the commits you want to get into this PR. Also, you created a PR from your main branch, which is generally a very bad idea, since every time you update your main branch from the upstream one you will also modify your PR. You should create a new branch from a clean upstream main branch and then put your script there and create a clean commit. You need a new PR of course. But I would have squashed your tons of commits anyway in this PR.

ok, sorry, I've created the new branch without the other files (in-note-text-tagging), there are still the other commits but it's probably possible to squash everything during the integration of the PR

adding txt2tags-it: support to txt2tags syntax in addition to the mar…

de38424

…kdown one

pbek requested a review from Copilot April 12, 2026 05:29

Copilot started reviewing on behalf of pbek April 12, 2026 05:30 View session

Copilot AI reviewed Apr 12, 2026

View reviewed changes

pbek reviewed Apr 12, 2026

View reviewed changes

Comment thread txt2tags-it/info.json Outdated

Comment thread txt2tags-it/info.json Outdated

Comment thread txt2tags-it/info.json Outdated

pbek added the wip Work in progress label Apr 12, 2026

luginf and others added 3 commits April 14, 2026 20:37

updating and fixing

b33b8be

fix version and credits

edf9e8c

luginf and others added 4 commits April 15, 2026 01:09

chore: remove unused deflist and katex plugins

cb3881c

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

fix non white space before a tag. Allow to use either # or @ for tags…

ad55a6c

… (# is default)

pbek mentioned this pull request Apr 15, 2026

[FEATURE] Make editor highlighting more scriptable pbek/QOwnNotes#3549

Closed

Guard URL schemes

7fefe9a

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

luginf mentioned this pull request Apr 17, 2026

Txt2tags it #284

Open

luginf closed this Apr 17, 2026

	finalPath = resolvePath(basePath, rawPath.replace(/^\.\/+/, ''));
	finalPath = resolvePath(path, rawPath.replace(/^\.\/+/, ''));

	"text": "Enable the Markdown-it definition list KaTeX plugin",
	"text": "Enable the Markdown-it KaTeX / LaTeX rendering plugin",

Conversation

luginf commented Apr 11, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 12, 2026

Choose a reason for hiding this comment

Uh oh!

pbek Apr 15, 2026

Choose a reason for hiding this comment

Uh oh!

luginf Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 12, 2026

Choose a reason for hiding this comment

Uh oh!

pbek Apr 15, 2026

Choose a reason for hiding this comment

Uh oh!

luginf Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 12, 2026

Choose a reason for hiding this comment

Uh oh!

pbek Apr 15, 2026

Choose a reason for hiding this comment

Uh oh!

luginf Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

luginf Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

luginf commented Apr 12, 2026

Uh oh!

pbek commented Apr 12, 2026

Uh oh!

luginf commented Apr 13, 2026

Uh oh!

pbek commented Apr 13, 2026

Uh oh!

luginf commented Apr 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Qt6:

General Info

Server Info

Script txt2tags-it

Qt5

General Info

Script txt2tags-it

Uh oh!

luginf commented Apr 14, 2026

Uh oh!

luginf commented Apr 15, 2026

Uh oh!

pbek commented Apr 15, 2026

Uh oh!

luginf commented Apr 15, 2026

Uh oh!

pbek commented Apr 15, 2026

Uh oh!

luginf commented Apr 15, 2026

Uh oh!

luginf commented Apr 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

luginf commented Apr 14, 2026 •

edited

Loading

Script `txt2tags-it`

Script `txt2tags-it`

luginf commented Apr 15, 2026 •

edited

Loading

pbek commented Apr 15, 2026 •

edited

Loading

luginf commented Apr 16, 2026 •

edited

Loading