Open meichthys opened 2 months ago
The current idea as summarized here is to develop the page inside the Docs repo and push that to a Trilium instance.
Relevant original Trilium issue: https://github.com/zadam/trilium/issues/3826
@meichthys , yes, but apparently no one offered to help with the design. We'll probably have to make do with a template.
I think a template is sufficient for now 👍
If we want to include the documentation with this, then i think we need to re-work the docs repo to have less of a flat directory structure. We should nest relevant documentation notes (like we do in Trilium), however this gets tricky when a documentation 'note' should exist under multiple top-level notes. This is where Trilium's clone feature is very powerful - but hard to replicate in a git repository(?).
The idea of using a Trilium instance to host docs has merit, and I really like https://trilium.rocks/. But I wanted to throw out the idea of using Sphinx w/Markdown as I didn't see it mentioned -- it's easy to automate the build using a GitHub action and easily hostable through GitHub Pages, which can be owned by the organization.
Here's an example from one of my projects: https://mm21.github.io/trilium-alchemy/
And the corresponding docs source tree is here: https://github.com/mm21/trilium-alchemy/tree/main/doc
Sphinx lends itself nicely to a simple hierarchical organization compatible with a filesystem, and it supports extensions for more advanced features like generating diagrams on-the-fly from text descriptions (PlantUML or Mermaid.js). While it's especially well-suited for Python projects, it supports many coding languages and is flexible enough for people to use it to write books, etc using Markdown. (You don't need to know Python to work with it, except for a simple flat configuration file -- besides that you just invoke the CLI and point to your source directory.)
@rauenzi could definitely help out if we wanted a design similar to https://trilium.rocks, and if you need me to do anything with the triliumnext.com domain @chesspro13 just let me know!
If we wanted to go the direction of Hugo or Jekyll (when it comes to static site generators), I could help there, if we used a template.
For the moment it looks like https://github.com/TriliumNext/Docs/ could serve as a landing page
Discussed in https://github.com/orgs/TriliumNext/discussions/209