1
0
mirror of https://github.com/laurent22/joplin.git synced 2024-12-18 09:35:20 +02:00
joplin/packages/renderer
Laurent Cozic 3f2fe79151 All: Partially reverts #3975 (link rendering)
- Reverts the linkify behaviour - URLs will be auto-detected again
- Keeps the new soft-break behaviour

There are still unsolved issues with regard to the linkify option so it
needs further considerations before we change the behaviour.

https://discourse.joplinapp.org/t/12620/18?u=laurent
2020-11-23 16:52:17 +00:00
..
assets All: Use Lerna to manage monorepo 2020-11-05 16:58:23 +00:00
lib All: Use Lerna to manage monorepo 2020-11-05 16:58:23 +00:00
MdToHtml Desktop, Mobile: Fixes #4119: Fixed links imported from ENEX as HTML 2020-11-20 16:04:47 +00:00
tests All: Use Lerna to manage monorepo 2020-11-05 16:58:23 +00:00
Tools All: Use Lerna to manage monorepo 2020-11-05 16:58:23 +00:00
vendor All: Use Lerna to manage monorepo 2020-11-05 16:58:23 +00:00
.gitignore All: Use Lerna to manage monorepo 2020-11-05 16:58:23 +00:00
assetsToHeaders.js All: Use Lerna to manage monorepo 2020-11-05 16:58:23 +00:00
defaultNoteStyle.js All: Use Lerna to manage monorepo 2020-11-05 16:58:23 +00:00
HtmlToHtml.ts Desktop, Mobile: Fixes #4119: Fixed links imported from ENEX as HTML 2020-11-20 16:04:47 +00:00
htmlUtils.ts Desktop, Mobile: Fixes #4119: Fixed links imported from ENEX as HTML 2020-11-20 16:04:47 +00:00
index.ts Desktop, Mobile: Fixes #4119: Fixed links imported from ENEX as HTML 2020-11-20 16:04:47 +00:00
InMemoryCache.ts Tools: Apply rule @typescript-eslint/member-delimiter-style 2020-11-12 19:29:22 +00:00
jest.config.js Desktop, Mobile: Fixes #4119: Fixed links imported from ENEX as HTML 2020-11-20 16:04:47 +00:00
MarkupToHtml.ts Desktop, Mobile: Fixes #4119: Fixed links imported from ENEX as HTML 2020-11-20 16:04:47 +00:00
MdToHtml.ts All: Partially reverts #3975 (link rendering) 2020-11-23 16:52:17 +00:00
noteStyle.ts Tools: Apply rule @typescript-eslint/type-annotation-spacing 2020-11-12 19:13:28 +00:00
package-lock.json Desktop, Mobile: Fixes #4119: Fixed links imported from ENEX as HTML 2020-11-20 16:04:47 +00:00
package.json Desktop, Mobile: Fixes #4119: Fixed links imported from ENEX as HTML 2020-11-20 16:04:47 +00:00
pathUtils.ts Tools: Apply rule @typescript-eslint/type-annotation-spacing 2020-11-12 19:13:28 +00:00
publish.sh All: Use Lerna to manage monorepo 2020-11-05 16:58:23 +00:00
README.md All: Use Lerna to manage monorepo 2020-11-05 16:58:23 +00:00
stringUtils.js All: Use Lerna to manage monorepo 2020-11-05 16:58:23 +00:00
tsconfig.json All: Use Lerna to manage monorepo 2020-11-05 16:58:23 +00:00
urlUtils.js All: Use Lerna to manage monorepo 2020-11-05 16:58:23 +00:00
utils.ts Desktop, Mobile: Fixes #4119: Fixed links imported from ENEX as HTML 2020-11-20 16:04:47 +00:00

Joplin Renderer

This is the renderer used by Joplin to render notes in Markdown or HTML format.

Installation

npm i -s joplin-renderer

Certain plugins require additional assets like CSS, fonts, etc. These assets are in the /assets directory and should be copied to wherever the application can find them at runtime.

Usage

const { MarkupToHtml } = require('joplin-renderer');

const options = {};

// The notes are rendered using the provided theme. The supported theme properties are in `defaultNoteStyle.js`
// and this is what is used if no theme is provided. A `theme` object can be provided to override default theme
// properties.
const theme = {};

const markdown = "Testing `MarkupToHtml` renderer";

const markupToHtml = new MarkupToHtml(options);
const result = await markupToHtml.render(MarkupToHtml.MARKUP_LANGUAGE_MARKDOWN, markdown, theme, options);

console.info('HTML:', result.html);
console.info('Plugin assets:', result.pluginAssets);

When calling render(), an object with the following properties is returned:

  • html: The rendered HTML code
  • pluginAssets: The assets required by the plugins

The assets need to be loaded by the calling application. For example this is how they are loaded in the Joplin desktop application:

function loadPluginAssets(assets) {
	for (let i = 0; i < assets.length; i++) {
		const asset = assets[i];

		if (asset.mime === 'text/css') {
			const link = document.createElement('link');
			link.rel = 'stylesheet';
			link.href = 'pluginAssets/' + asset.name;
			document.getElementById('joplin-container-styleContainer').appendChild(link);
		}
	}
}

Development

Updating a markdown-it plugin

Whenever updating a Markdown-it plugin, such as Katex or Mermaid, make sure to run npm run buildAssets, which will compile the CSS and JS for use in the Joplin applications.

### Adding asset files

A plugin (or rule) can have any number of assets, such as CSS or font files, associated with it. To add an asset to a plugin, follow these steps:

  • Add the file under /assets/PLUGIN_NAME/your-asset-file.css
  • Register this file within the plugin using context.pluginAssets[PLUGIN_NAME] = [{ name: 'your-asset-file.css' }]

See katex.js for an example of how this is done.

Adding inline CSS

A plugin can ask for some CSS to be included inline in the rendered HTML. This is convenient as it means no extra file needs to be packaged. Use this syntax to do this:

context.pluginAssets[PLUGIN_NAME] = [
	{
		inline: true,
		text: ".my-css { background-color: 'green' }",
		mime: 'text/css',
	},
];