(Feature request) [Meta] Use Trilium to host Trilium Wiki

zadam / trilium

Build your personal knowledge base with Trilium Notes

GNU Affero General Public License v3.0

27.2k stars 1.9k forks source link

(Feature request) [Meta] Use Trilium to host Trilium Wiki #3826

Open meichthys opened 1 year ago

meichthys commented 1 year ago

Describe feature

How cool would it be to host the Trilum wiki on Trilum itself!

Benefits

Easier(?) to update wiki
Would inspire confidence in Trilum
It could eventually be used to host a 3rd Party list of plugins
- The plugins could be added as zip file and shared publicly
- The zip file could then be downloaded and imported in to a local Trilium instance (All attributes preserved! no need to copy/paste code, or add #widget label!)
Perhaps this instance could also act as a demo instance (This might now work with the current limitation of a single user/instance per deployment)

Drawbacks

Would incur financial hosting costs

zadam commented 1 year ago

Actually I did quite a lot of work in this direction in the recent months, but there's quite a lot of complexity involved, and I'm not sure anymore if it's worth it, so I've paused the work for now.

meichthys commented 1 year ago

Ok, If there's anything not too technical that I could help out with, just let me know.

zerebos commented 1 year ago

I'd also be willing to help out with this, whether it be technical or otherwise.

meichthys commented 1 year ago

@zadam Could you roughly outline the complexities that you were seeing when you looked at this previously?

zadam commented 1 year ago

Some things I remember:

one of my main motivations for this effort was to use this as offline help within Trilium app itself.
- My idea was that this help/guide is imported into the hidden subtree and thus behaves like normal note in the sense that it can be linked to, opened in new tab/split etc.
- This user guide would be packaged as note export ZIP (similar to demo document), during upgrade checked and overridden if needed.
- This idea has some complexities like that the noteId has to be kept stable across upgrades so that the links stay alive
there needs to be some workflow associated with authoring / publishing
- the documentation should still be versioned in git which would allow some kind of contributions / cooperation

I think there were some other ones, but it's been a couple months ...

zerebos commented 1 year ago

I think the ability to have the help be in-app as well is great, but it feels like that would only contain documentation concerning real end-users, and not so much documentation on creating addons for Trilium. So that would also be another piece to tackle with this plan. Or do you think it should contain both end-user and developer docs, including the api reference?

As for keeping it and authoring it in git, it could be contained in a separate git repo and included via submodule or similar. Or even included by using it as an npm package (directly installed through github, no need to publish to npm).

meichthys commented 1 year ago

IMO, I'd like to see the developer docs included too since many (most?) trilium users are power users who would benefit from the Dev docs.

zadam commented 1 year ago

@rauenzi I actually targeted end user, dev docs and API docs. That was another challenge, getting the jsdoc generated docs into something usable offline.

zerebos commented 1 year ago

@zadam I gotcha, that's something I can definitely help with, I've got experience using JSDoc to output to non-web outputs like markdown (used here https://docs.betterdiscord.app/api/ source here https://github.com/BetterDiscord/docs/blob/main/docs/api/bdapi.md) so I'm sure we could use similar techniques to make it work with whatever you have in mind.