https://github.com/nil0x42/singlefile2trilium

Save faithful copy of a web page in Trilium notes with SingleFile web extension :electric_plug:
https://github.com/nil0x42/singlefile2trilium

note-taking plugin singlefile trilium trilium-plugin

Last synced: 2 months ago
JSON representation

Save faithful copy of a web page in Trilium notes with SingleFile web extension :electric_plug:

• Host: GitHub
• URL: https://github.com/nil0x42/singlefile2trilium
• Owner: nil0x42
• Created: 2019-12-05T18:23:49.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-05-26T12:02:36.000Z (over 2 years ago)
• Last Synced: 2024-11-02T06:34:11.867Z (2 months ago)
• Topics: note-taking, plugin, singlefile, trilium, trilium-plugin
• Language: Python
• Homepage:
• Size: 1.08 MB
• Stars: 97
• Watchers: 3
• Forks: 12
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-trilium - singlefile2trilium - commit/nil0x42/singlefile2trilium) (🧚 API extensions / 🍎 iOS)

README

        
# singlefile2trilium

Save faithful copy of a web page as a [Trilium] note with [SingleFile] web extension.

[![twitter follow](https://img.shields.io/twitter/follow/nil0x42?label=Follow%20nil0x42%20%21&style=social)](https://twitter.com/intent/follow?screen_name=nil0x42)

![](img/small-demo.png)

## How it Works

[SingleFile] web extension saves a faithful copy of the web page being rendered by your browser as a single HTML file.

It's default location is `~/Downloads`.

#### singlefile2trilium is composed of two scripts:

1. **[singlefile2trilium-sender.py]** script continuously watches `~/Downloads` directory for new html pages saved by `SingleFile` and sends them to trilium.

2. **[singlefile2trilium-handler.js]** is a trilium [custom request handler]. It handles and converts data sent by `singlefile2trilium-sender.py`.

The handler wraps the html content into an html iframe, which is itself rendered by a render note.

## Installation

Dependencies:

* Python 3.x

* [Trilium] >= v0.38

* [SingleFile]

#### A) Configure [singlefile2trilium-handler.js]

1. add the file to trilium as a `JS Backend` code note:

   ![](img/add-handler-to-trilium.png)

2. set `customRequestHandler` label to `singlefile2trilium`:

   ![](img/set-label-to-handler.png)

#### B) Configure [singlefile2trilium-sender.py]

1. copy the script somewhere on your computer.

2. change `BASEDIR` & `TRILIUM_URL` vars in script according to your needs.

3. configure your system to [run the script at startup](https://specifications.freedesktop.org/autostart-spec/autostart-spec-latest.html) (as a daemon):

   ```bash

   user@desktop $ ./singlefile2trilium-sender.py

   ```

## Usage

1. Use **SingleFile** add-on in your browser to save a web page

   ![](img/use-singlefile.png)

2. You have now a new **Trilium** note rendering faithfully the web page in your [day note](https://github.com/zadam/trilium/wiki/Day-notes)

   ![](img/page-rendered-in-trilium.png)

## Throubleshotting

* Ensure trilium installed version is > 0.38

* Here is a screenshot of my own singlefile config, may help if default options don't work:

  ![](img/singlefile-config.png)

[singlefile2trilium-sender.py]: singlefile2trilium-sender.py

[singlefile2trilium-handler.js]: singlefile2trilium-handler.js

[Trilium]: https://github.com/zadam/trilium

[custom request handler]: https://github.com/zadam/trilium/wiki/Custom-request-handler

[SingleFile]: https://github.com/gildas-lormeau/SingleFile