1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-06-16 10:29:54 +00:00

Improve docs on installing plugins under Node.js

This commit is contained in:
Jeremy Ruston 2019-11-02 13:19:00 +00:00
parent 14e799d36b
commit df85281420
4 changed files with 23 additions and 8 deletions

View File

@ -1,6 +1,6 @@
created: 20150926162849519
modified: 20180701185329863
tags: [[Installing TiddlyWiki on Node.js]]
modified: 20191022095509822
tags: [[TiddlyWiki on Node.js]]
title: Installing TiddlyWiki Prerelease on Node.js
type: text/vnd.tiddlywiki

View File

@ -0,0 +1,15 @@
created: 20191022095653896
modified: 20191102131824766
tags: [[TiddlyWiki on Node.js]]
title: Installing custom plugins on Node.js
type: text/vnd.tiddlywiki
There are several ways in which custom plugins that are not part of TiddlyWiki's plugin library can be installed when using TiddlyWiki under Node.js. (See [[Installing a plugin from the plugin library]] for instructions on installing plugins from the library).
* Arrange the PluginFolders containing the plugins in a convenient shared location and then use [[environment variables|Environment Variables on Node.js]] to tell TiddlyWiki to search those folders. The plugins can be referenced in `tiddlywiki.info` by their name (e.g. `tiddlytools/magic`)
* Place the PluginFolders containing the plugins in a `plugins` folder within the [[wiki folder|TiddlyWikiFolders]]
* Depending on how TiddlyWiki itself has been installed, plugins can also be installed by copying the plugin folders into the `plugins` folder of the repository. This is only recommended if working with a forked copy of the repo. It is not recommended if TiddlyWiki has been installed with npm because npm is liable to overwrite the installation when performing an update
Note that including a plugin as an ordinary tiddler (e.g. by dragging and dropping a plugin into the browser) will result in the plugin only being active in the browser, and not available under Node.js.

View File

@ -1,5 +1,5 @@
created: 20131129094353704
modified: 20150412185457193
modified: 20191022095309607
tags: Platforms
title: TiddlyWiki on Node.js
type: text/vnd.tiddlywiki
@ -18,6 +18,4 @@ There are a few file system limitations you should be aware of that are related
For more information see:
* [[Installing TiddlyWiki on Node.js]]
* [[Using TiddlyWiki on Node.js]]
* [[Upgrading TiddlyWiki on Node.js]]
<<list-links "[tag[TiddlyWiki on Node.js]]">>

View File

@ -1,6 +1,6 @@
created: 20160107222352710
modified: 20160720145836265
tags: Plugins
modified: 20191022095637710
tags: [[TiddlyWiki on Node.js]] Plugins
title: Installing a plugin from the plugin library
type: text/vnd.tiddlywiki
@ -46,3 +46,5 @@ Follow these instructions when using TiddlyWiki under Node.js:
]
}
```
See also [[Installing custom plugins on Node.js]].