Skip to content

doc: add server usage and better build pipline #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
linonetwo wants to merge 1 commit into
base: master
Choose a base branch
from
Open

doc: add server usage and better build pipline #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ node_modules
*.swp
*.swo
index.html
build/
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,21 @@ login to your Solid pod and start writing, everything will be saved on your Soli

When you connect in the future you will find your 'tiddlers' listed under you 'tags' or under 'untagged'.

## Use on your server

After `npm i && npm run build`, you will see a folder inside `./build`, copy that folder into your tiddlywiki server's `tiddlers` folder, and edit your `tiddlywiki.info`'s plugin section, add `"$:/plugins/bourgeoa/nodesolidserver"`, it will looks likes:

```json
"plugins": [
"tiddlywiki/tiddlyweb",
"tiddlywiki/filesystem",
"tiddlywiki/highlight",
"$:/plugins/bourgeoa/nodesolidserver"
],
```

Restart your server, this syncadaptor will be built into your tiddlywiki.

## Acknowledgements

Many thanks for inspiration from https://github.com/remotestorage/remotestorage-widget, https://github.com/fiatjaf/tiddlywiki-remotestorage
Expand Down
Loading