Skip to content

export notes as website

bvn9ne edited this page Nov 28, 2022 · 2 revisions

Export notes as website

This script exports all notes in the collection as interlinked HTML files that can be viewed using any web browser.

Additional documentation for this script can be found on the development wiki. The wiki website is also a demo, since it has been written entirely in QOwnNotes and exported directly to HTML using this script.

Usage

Installing the script should add a new custom action ("Export notes as website") to the Scripting menu in QOwnNotes. Clicking this will export all notes in the current collection to HTML files in a new folder called export.

After opening any of the exported HTML files in a browser, it should be possible to click through internal links just like in QOwnNotes.

Settings

File Export Selection

This selection has two options. Save files in each notebook (old behavior) uses the older behavior of saving an exported website in a subfolder located in the notes directory. Save files in a central location saves exported websites to a selected folder. Each notebook's website will be located in a subfolder named after the notebook.

Set export folder name

When using Save files in each notebook (old behavior), this is the name of the subfolder where the website will be saved. The default is export in keeping with the old behavior. Exports will also default to this name if the export folder name is left blank. This setting is ignored when using Save files in a central location.

Set base folder for website export

When using Save files in a central location, this is the root folder where all exports are kept. If this name is blank, Save files in each notebook (old behavior) is used regardless of File Export Selection. This setting is ignored when Save files in each notebook (old behavior) is selected.

Using this script with backlinks

Note that in order to include backlinks in the exported HTML you will need to (temporarily) select "Trigger backlink generation on preview" from the backlinks script options. After exporting, this option should be unselected, as it may interfere with performance (since it causes backlinks to be generated "live" whenever the preview changes, instead of just once on opening the note).

Backlinks has not been tested in Windows.