A custom desktop browser for TiddlyWiki 5 and TiddlyWiki Classic, based on nw.js

Related tags

javascript nwjs tiddlywiki
Overview

TiddlyDesktop

TiddlyDesktop is a special purpose web browser for working with locally stored TiddlyWikis. See http://tiddlywiki.com/ for more details of TiddlyWiki.

See this video tutorial for an overview of installing and using TiddlyDesktop on Windows and OS X:

https://www.youtube.com/watch?v=i3Bggkm7paA

It is based on nw.js, a project created and developed in the Intel Open Source Technology Center:

https://github.com/nwjs/nw.js

Download and Install

Download the Windows, linux or Mac binary .zip files from:

https://github.com/Jermolene/TiddlyDesktop/releases

Unzip into a folder and run TiddlyWiki.app or nw.exe and for linux nw

Note that TiddlyDesktop will not work correctly from a Windows UNC network share (eg \\MY-SERVER\SHARE\MyFolder). You should map the network share to a local drive, and run it from there.

Usage

Multiple Configurations

To have separate mutliple instances of TiddlyDesktop (for example, separate Personal and Professional instances), you can pass the --user-data-dir argument. e.g. /opt/TiddlyDesktop/nw --user-data-dir=/mnt/data/TiddlyWiki/config. The property should be a directory to use for holding configuration data.

Developer Tools

The F12 key opens the Chromium developer tools for the current window.

Building

  1. Run download-nwjs.sh to download the latest nw.js binaries
  2. Download the TiddlyWiki5 repo from https://github.com/Jermolene/TiddlyWiki5 to a sibling directory to the TiddlyDesktop repo called "TiddlyWiki5"
  3. Run bld.sh
  4. Execute output/mac/TiddlyWiki.app or output/win/nw.exe or output/linux32/nw or output/linux64/nw
Issues
  • Support for TW Classic in TiddlyDesktop 0.0.9

    Support for TW Classic in TiddlyDesktop 0.0.9

    I have used mGTD, based on Tiddlywiki Classic, with TiddlyDesktop 0.0.8 for a long time, without any major problems. I downloaded version 0.0.9 and ran into the problem of not being able to save my edits. When I click Save, the error message I get is:

    It’s not possible to save changes. Possible reasons include:

    • your browser doesn’t support saving (Firefox, Internet Explorer: Safari and Opera all work if properly configured)
    • the pathname to your TiddlyWiki file contains illegal characters
    • the TiddlyWiki HTML file has been moved or renamed

    I believe this is related to Issue #3. From that issue, I got the impression that Tiddlywiki Classic is supported (and it worked fine in 0.0.8).

    opened by jockster74 34
  • Open a specific wiki when passed on the command line

    Open a specific wiki when passed on the command line

    Fix for #85. If a file or folder path is specified after ./nw that wiki is used in place of backstage://WikiListWindow as the "main" window.

    ~~Note: I cannot figure out what the empty value of gui.App.argv is, so I am using != rather than !==. Hopefully someone else knows what that might be, and I can correct things.~~

    opened by mklauber 34
  • Proposition to add td releases to tw.com

    Proposition to add td releases to tw.com

    Hi, don't you think that tiddlydesktop's releases deserves a place on tw main site, maybe by adding a tab to the "release" tiddler ? (see exemple below)

    capture du 2015-01-16 16 38 41

    enhancement 
    opened by Spangenhelm 33
  • Add spell-checking support

    Add spell-checking support

    One nice thing about running TiddlyWiki in a full browser is that most of them have built-in spell checkers. It would be nice to have this same functionality in TiddlyDesktop as well.

    more-like-a-browser 
    opened by DMLou 24
  • nw.exe is running, but no window, even after kill&start

    nw.exe is running, but no window, even after kill&start

    Using 0.0.4. I see 3 nw.exe instances (one parent, two child). I try to kill the parent and children and run again and again I see the 3 processes, but now window (a blank window appears for 2 seconds and then it is gone). In process explorer neither of these processes has an associated window

    opened by ittayd 19
  • TiddlyDesktop v0.0.4 64bits linux version doesn't launch

    TiddlyDesktop v0.0.4 64bits linux version doesn't launch

    Apparently the nw app does not launch at all (permission is set to executable) when trying from the file manager (nothing happen, no error displayed), unfortunatly i don't know how to launch it from the terminal, i have tried "nw" and "exec nw" with the right path but the cli return this: "bash: nw command not found" anyway i don't have this problem with 0.0.3 which works fine.

    bug 
    opened by Spangenhelm 17
  • External Attachments Plugin not working

    External Attachments Plugin not working

    I am on Windows 10 and I tried with both the 32 and 64 bit versions.

    I load a new, empty TW file, I open it, I install the above mentioned plugin and I try to import an image (I tried importing various types of files from a variety of locations including at the same level as the TW file, under and above). I tried with both the import file button (the paperclip icon) and via drag and drop (dragging a file on the window shows the usual green bar before dropping). It doesn't matter the file type, its location or where I drop it in the windows, at this point the window goes black and shows a preview of the image (or the pdf or whatever) instead of the import dialog. Sometimes it shows instead the red popup 'internal javascript error...reload' but I have no way to reload the page (tried ctrl-r or f5). Sometimes this red box flashes for an instant and then the windows goes black as described above. At this point I need to close the window and restart NW.

    Note that if the plugin is not installed everything works as it should and I can import anything with no error. But as I said, this is not my goal as these files get embedded decreasing the performance of my TW (which is not the goal of EAP neither).

    Please help!

    opened by flygohr 12
  • TiddlyDesktop includes TiddlyWiki Classic source files

    TiddlyDesktop includes TiddlyWiki Classic source files

    Too old files for TW2 Core:

    .\tiddlywiki\editions\tw2\source\tiddlywiki\

    Actual version is 2.7.0, but in /tiddlywiki/editions/tw2/source/tiddlywiki/js/Version.js is var version = {title: "TiddlyWiki", major: 2, minor: 6, revision: 5, date: new Date("October 6, 2011"), extensions: {}};

    opened by KarelWintersky 11
  • Main window won't show up

    Main window won't show up

    After using TiddlyDesktop a few times the main window won't show up at start, but I can see it on the taskbar and (in v0.0.8) on the tray. It happened with v0.0.6 before twice, now it happens quite frequently.

    Deleting Users/[username]/AppData/Local/TiddlyDesktop solves the problem temporarily.

    opened by processo 10
  • Spaces in pathname disrupts import features

    Spaces in pathname disrupts import features

    Nothing happens when I try to import files from my PC. The green ribbon on the top shows up, but after I drop the items, the $:/Import tiddler doesn't open. I have also tried via Tools->Import - again, nothing.

    However, pasting text with CTRL+V works. Drag/Drop tiddlers from another wiki also works.

    Tested with version 5.0.16

    opened by braykov 10
  • Spellcheck in multiple languages

    Spellcheck in multiple languages

    Hi,

    Sometimes it can be very handy to write tiddlers in different languages. However, the current configuration in the spellchecker only allows a single dictionary/language, English by default. I´ve come across this https://github.com/nwjs/nw.js/issues/4954#issuecomment-305747232 in which they show how to bring the multilanguage spellchecking support to NW.js.

    I can confirm it is working in the latest version of TiddlyDesktop after enabling this flag in the developer console (F12). chrome.settingsPrivate.setPref('spellcheck.dictionaries', ["es-ES", "en-GB"], "null", console.log.bind(console, "done"));

    opened by ijpascual 0
  • Remove superfluous menu bar item on the Mac.

    Remove superfluous menu bar item on the Mac.

    Fixes issue #117.

    opened by dented42 2
  • TiddlyDesktop is crashing on macOS Big Sur 11.2 on next start if exited in fullscreen mode.

    TiddlyDesktop is crashing on macOS Big Sur 11.2 on next start if exited in fullscreen mode.

    TiddlyDesktop is repeatedly crashing on M1 powered MacBook computers if Microsoft Teams is running at the same time.. While I'm not knowledgeable about underpinnings of the TiddlyDesktop and Electron applications, I can do testing and guided poking on the system.

    I've attached a typical crash report. It's here.

    Crashes happen while working on a Wiki file, and while trying to reopen the software again.

    Steps to Reproduce

    1. Open Microsoft Teams
    2. Open Tiddly Wiki
    3. Try to open a Wiki file and edit it.
    4. The crash will find you. Repeatedly.
    opened by hbayindir 28
  • Tiddlydesktop wiki list window is empty (plain white)

    Tiddlydesktop wiki list window is empty (plain white)

    I've been using Tiddlydesktop for about year on my Mac. After upgrade to Big Sur a few weeks ago, it still worked ok.

    Today, when I launch Tiddydesktop, all screens (wiki list screen, Settings screen, help screen) all come up completely empty/blank -- it's just a white area below the title bar (see screenshot).

    I've just downloaded the latest version of TD and rebooted after installing it, but the issue remains.

    Is there some config I could reset? Where would those files live?

    Screenshot 2021-01-13 at 19 46 31

    opened by alexhunsley 1
  • Saving tiddlers does not work in GNU/Linux

    Saving tiddlers does not work in GNU/Linux

    I have built TiddlyDesktop as described in the readme on Debian10/KDE.

    I added two new tiddly wikis using the two templates and clicked open on one of them (same problem for both). Then I edited the "Getting Started" tiddler and added a new tiddler entering some text there. I clicked Confirm changes to this tiddler which caused a small popup in the upper right corner that said it was saved. Then I clicked "Save changes" which also got confirmed in a popup. I then closed the window and clicked on Open on the edited TiddlyWiki. No changes or added tiddlers were displayed - it only showed the empty html.

    ERROR:sandbox_linux.cc(376)] InitializeSandbox() called with multiple threads in process gpu-process.
    (node:15559) [DEP0005] DeprecationWarning: Buffer() is deprecated due to security and usability issues. Please use the Buffer.alloc(), Buffer.allocUnsafe(), or Buffer.from() methods instead.
    

    This seems to be related to #215. The problems could be related to nw.js's use of /proc/self/exe processes as described in #221. However, it looks like this error should not be a problem and the cause of saving not to work, see: https://github.com/nwjs/nw.js/issues/7316.

    Furthermore during the tests it once asked for access to the KDE wallet (storage of passwords) and I don't see why.

    These are probably problems related to nwjs. Currently using only electron.js-based software such as the Zettlr alternative or cirectly node.js-based ones like Wiki.js (not desktop).

    opened by mYnDstrEAm 0
  • Disabling mDNS

    Disabling mDNS

    By running sudo lsof -i on Debian I found that TiddlyDesktop runs mDNS. Why is that and how to turn it off? It sends multicast mDNS packets from nw and /proc/self/exe processes (afaik the latter are symbolic links to the nw executable). Maybe it runs mDNS to enable TiddlyWiki access from other machines on the local network or sharing of ones TiddlyWiki with other people. Any details about that and the use of /proc/self/exe here?

    I don't want to have the TiddlyWiki accessible from anywhere else than the local machine, would like to restrict network activity to what is needed and explicitly permitted, and could not find a setting to turn it off in the preferences.

    opened by mYnDstrEAm 1
  • Create new wiki -> Clone wiki folder doesn't copy any files

    Create new wiki -> Clone wiki folder doesn't copy any files

    Using the "Create new wiki" in the wiki list window to clone an existing folder-based wiki fails to copy any files.

    Original discussion: https://groups.google.com/d/msgid/tiddlywiki/13de6cd9-1226-4ef8-a381-b4e4fdcbdc92n%40googlegroups.com

    opened by Jermolene 0
  • "tm-full-screen" message doesn't work in TiddlyDesktop

    And thus the "full screen" button in the "Tools" sidebar tab doesn't function in TiddlyDesktop.

    image

    Original discussion: https://groups.google.com/d/msgid/tiddlywiki/fdf74336-7a6e-4d4c-8a13-ccb72c410bf2n%40googlegroups.com?utm_medium=email&utm_source=footer

    opened by Jermolene 0
  • Please add hashsums for the releases to better ensure the integrity of installed software

    Please add hashsums for the releases to better ensure the integrity of installed software

    The TiddlyWiki concepts and software seems really interesting, useful and powerful, especially with recent extension built upon it.

    However, sadly it looks like this software is not only missing a license (#213) or even just a pledge that it will be licensed under an MIT-License-like free license...it's also missing the most basic security measures to ensure the integrity of the downloaded software.

    There are no hashsums for the releases (and they aren't GPG signed either).

    This way one can't ensure the integrity of the downloaded files which is one of the most basic and easiest to resolve measures for security. It would be best to sign the releases with GPG but one could also simply add hashsums to the releases description or via another file. For me the sha512sum of tiddlydesktop-linux64-v0.0.14.zip was 54607e374005c87ee537a30e033087a6360c9dc8089c8b7e5ef5e8e0fc1c8d1c4a9bf102e476d2226a26730694ac437a51b3a919ab6a2d7c3268f06bc7d31901. Adding this string to the description would be all that's needed for a most basic step for ensuring integrity. Some more info here.

    Could you please add hashsums for the releases? I think one could use and support this software once this has been done and the license has been clarified.

    Edit: as of now one can build the project and verify the nw.js files after step 1 like this.

    opened by mYnDstrEAm 0
  • Current version still says 'prerelease' under 'create new wiki'

    Current version still says 'prerelease' under 'create new wiki'

    Any timeline for an updated TiddlyDesktop version?

    opened by dixonge 0
Releases(v0.0.15-prerelease.1)
Owner
Jeremy Ruston
Learning to program since 1978. Creator of @TiddlyWiki.
Jeremy Ruston
A custom desktop browser for TiddlyWiki 5 and TiddlyWiki Classic, based on nw.js

TiddlyDesktop TiddlyDesktop is a special purpose web browser for working with locally stored TiddlyWikis. See http://tiddlywiki.com/ for more details

Jeremy Ruston 1.1k Jun 2, 2021
Main repository of the zim desktop wiki project

Zim - A Desktop Wiki Editor Zim is a graphical text editor used to maintain a collection of wiki pages. Each page can contain links to other pages, si

Zim Desktop Wiki 1.2k Jun 4, 2021
A simple, Git-powered wiki with a sweet API and local frontend.

gollum -- A git-based Wiki Gollum version 5.0 is out! See here for a list of changes and new features compared to Gollum version 4.x, and see some Scr

null 11.5k Jun 7, 2021
Node.js based Wiki

JINGO A git based wiki engine written for node.js, with a decent design, a search capability and a good typography. Table of contents Introduction Fea

Claudio Cicali 986 Jun 3, 2021
A wiki using HAppS, pandoc, and git

Gitit Gitit is a wiki program written in Haskell. It uses Happstack for the web server and pandoc for markup processing. Pages and uploaded files are

John MacFarlane 1.9k Jun 4, 2021
Extendable Documentation Platform written in Laravel 5. Generate easy and awesome documentation!

Codex 2 - BETA! Introduction Codex is a file-based documentation platform built on top of Laravel. It's completely customizable and dead simple to use

Codex Project 148 Apr 25, 2021
Modern Confluence alternative designed for internal & external docs, built with Golang + EmberJS

Documize is an open source modern, lightweight and comprehensive alternative to Confluence and other such solutions. Built for technical and non-techn

Documize 1.3k Jun 5, 2021
The fastest wiki and knowledge base for growing teams. Beautiful, feature rich, and markdown compatible.

An open, extensible, wiki for your team built using React and Node.js. Try out Outline using our hosted version at www.getoutline.com. This is the sou

Outline 11.7k Jun 3, 2021
Git based wiki inspired by Gollum

Realms Wiki Beta Git based wiki written in Python Inspired by Gollum, Ghost, and Dillinger. Basic authentication and registration included. Demo: http

Matthew Scragg 832 Jun 6, 2021
A server for your markdown files. Give it a directory, and Commonplace gives you a url, pretty pages, and quick editing.

What is Commonplace? TL;DR: A server for your markdown files. Give it a directory, and Commonplace gives you a url, pretty pages, and quick editing. I

Fred Oliveira 173 Apr 29, 2021
A feature-rich wiki webserver for minimalists :cow: :speech_balloon:

A feature-rich wiki for minimalists cowyo is a self-contained wiki server that makes jotting notes easy and fast. The most important feature here is s

Zack 730 Jun 4, 2021
Extensible wiki system using CouchDB and written in Golang

Wikifeat Introduction Wikifeat is an open source collaboration platform built around the ever-popular Wiki concept. It is meant to be extensible and h

James Adam 99 Apr 28, 2021
Wiki with git backend

Ōlelo Wiki {{https://badge.fury.io/rb/olelo.png|Gem}} {{https://secure.travis-ci.org/minad/olelo.png?branch=master|Build Status}} {{https://gemnasium.

Daniel Mendler 241 Feb 22, 2021
A fast and lightweight site for viewing files

See more screenshots at https://imgur.com/a/15Gq67X A fast and lightweight site for viewing files. Great for documentation, wiki, examples, notes, doc

null 35 May 19, 2021