Difference between revisions of "Flat File Wikis"
Amidatelion (talk | contribs) |
Amidatelion (talk | contribs) |
||
(7 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
=Requirements= | =Requirements= | ||
− | Individuals list | + | Individuals should list their requirements, and others should make sub lists with "Accepted/Not Accepted" and any discussion points |
Example: | Example: | ||
Line 27: | Line 27: | ||
==Wulf's Requirements== | ==Wulf's Requirements== | ||
+ | While markdown is pretty great for most things, I can even see simple html+css going strong. There is a few things that are quality of life that we have now, or would like to get, that I don't know how to achieve. These may only be relevant for a few pages, that may be semi-manual or generative, and could be explicitly using HTML instead of a markdown default, but I don't know how to do this in Markdown. | ||
+ | |||
+ | * W1; Sortable Tables. I am unaware of any way to do this in markdown. This may only be relevant for a few pages, the list of mech overviews | ||
+ | ** Amid: Accepted | ||
+ | *** I'd completely forgotten about the sortable aspect because I never use that functionality. But you're right that we could just use raw html/css for that - most flat file engines have a way to "escape" the Markdown | ||
+ | |||
+ | * W2; Embeddable Images. I think there's a few markdown things that play with html tags or ![alt text](image_url). We use these in some guide stuff, and it'd be nice to not loose functionality. | ||
+ | ** Amid: Accepted | ||
+ | *** No contest, I think we're aligned on that and its just a matter of finding one that makes that easy | ||
+ | |||
+ | W3; TextTable Loadouts. Instead of updating pictures of the loadouts, generate loadouts in a nice positional layout like in the game. This would save all the storage and traffic, and should make the website more responsive and intuitive to use. I can imagine doing this in markdown with a fake table grid or so, but then hiding empty fields is like a weird extra layout step, and wouldn't know how to do this in markdown. | ||
+ | ** Amid: ? | ||
+ | *** If I'm understanding you correctly, this could be difficult, but I could also be not understanding you :sweat-smile: | ||
==BD's Requirements== | ==BD's Requirements== | ||
==Final Requirements== | ==Final Requirements== | ||
− | To be built | + | To be built as we agree on them |
+ | |||
+ | * Sane embeddable media support | ||
+ | ** Keep guide functionality as close to current | ||
+ | ** Clean interface/code to include them inline | ||
=Options So Far= | =Options So Far= | ||
+ | * [https://github.com/ppeetteerrs/obsidian-zola Obsidian Zola] | ||
+ | ** basically a direct way to host Obsidian vaults in netlify | ||
+ | ** would need some hacking to work self-hosted | ||
+ | * [https://quartz.jzhao.xyz/hosting Quartz] | ||
+ | ** Support Github and Obsidian markdown | ||
+ | ** also needs hacking to work self-hosted | ||
+ | * [https://www.bookstackapp.com/ Bookstack] | ||
+ | ** highly regarded on r/selfhosted | ||
* [https://www.docsy.dev/ Hugo theme: Docsy] | * [https://www.docsy.dev/ Hugo theme: Docsy] | ||
** Tabs! Tables! Rich menus! | ** Tabs! Tables! Rich menus! | ||
Line 60: | Line 85: | ||
** [https://www.reddit.com/r/selfhosted/comments/oe7xpp/markdown_based_wiki_i_can_git_push_to/h44yror/ Read Later] | ** [https://www.reddit.com/r/selfhosted/comments/oe7xpp/markdown_based_wiki_i_can_git_push_to/h44yror/ Read Later] | ||
* [https://tiddlywiki.com/ TiddlyWiki] | * [https://tiddlywiki.com/ TiddlyWiki] | ||
− | * [https://quiki.app Quiki] | + | ** Okay I have spent an hour trying to get my head around this and while I think I got it I don't think its intuitive for us or a user. |
+ | ** Performance wise tho, this thing is impressive | ||
+ | ** Could be convinced, leaving it up | ||
+ | * <s>[https://quiki.app Quiki]</s> | ||
+ | ** "Anyone can read it. Anyone can write it." Bullshit. You invented a Go templating language, immediately ran into problems, then had to write a dedicated section on escaping those problems to write html. | ||
+ | ** Absolutely not. | ||
* [http://dynalon.github.io/mdwiki MDwiki] | * [http://dynalon.github.io/mdwiki MDwiki] | ||
** No longer maintained? | ** No longer maintained? |
Latest revision as of 01:57, 31 January 2024
Requirements
Individuals should list their requirements, and others should make sub lists with "Accepted/Not Accepted" and any discussion points
Example:
==Fake Requirements== * Full Emoji Support ** Amid: Not Accepted *** You're dumb and bad * No PHP ** Amid: Accepted *** Sane * No Java ** Amid: Accepted *** It's 2024, fuck off with JVMs.
Amid's Requirements
- Uses Markdown or similar "light" language that is easily understood
- No PHP
- No Java
- No Lua
- Can be hosted in light CMS options
- Looks purdy/Modern
- Sane picture/media support
Wulf's Requirements
While markdown is pretty great for most things, I can even see simple html+css going strong. There is a few things that are quality of life that we have now, or would like to get, that I don't know how to achieve. These may only be relevant for a few pages, that may be semi-manual or generative, and could be explicitly using HTML instead of a markdown default, but I don't know how to do this in Markdown.
- W1; Sortable Tables. I am unaware of any way to do this in markdown. This may only be relevant for a few pages, the list of mech overviews
- Amid: Accepted
- I'd completely forgotten about the sortable aspect because I never use that functionality. But you're right that we could just use raw html/css for that - most flat file engines have a way to "escape" the Markdown
- Amid: Accepted
- W2; Embeddable Images. I think there's a few markdown things that play with html tags or ![alt text](image_url). We use these in some guide stuff, and it'd be nice to not loose functionality.
- Amid: Accepted
- No contest, I think we're aligned on that and its just a matter of finding one that makes that easy
- Amid: Accepted
W3; TextTable Loadouts. Instead of updating pictures of the loadouts, generate loadouts in a nice positional layout like in the game. This would save all the storage and traffic, and should make the website more responsive and intuitive to use. I can imagine doing this in markdown with a fake table grid or so, but then hiding empty fields is like a weird extra layout step, and wouldn't know how to do this in markdown.
- Amid: ?
- If I'm understanding you correctly, this could be difficult, but I could also be not understanding you :sweat-smile:
- Amid: ?
BD's Requirements
Final Requirements
To be built as we agree on them
- Sane embeddable media support
- Keep guide functionality as close to current
- Clean interface/code to include them inline
Options So Far
- Obsidian Zola
- basically a direct way to host Obsidian vaults in netlify
- would need some hacking to work self-hosted
- Quartz
- Support Github and Obsidian markdown
- also needs hacking to work self-hosted
- Bookstack
- highly regarded on r/selfhosted
- Hugo theme: Docsy
- Tabs! Tables! Rich menus!
- So fucking complicated calling it a Hugo theme is really stretching the definition
- Hugo theme: Lotus Docs
- No relation to Lotus Notes
- So fucking sexy
- Obsidian
- needs a frontend for hosting?
- wiki.js
- Needs db? but backs up to flat files? I'm confused
- Further research needed
- docsify.js
- Uuuuuugh fragment based pages, kill me
DokuWiki- PHP
- Not actually flat file? Why does this keep coming up in searches :/
- "Open the install.php file in your browser and follow the instructions" Annnnnd into the bin it goes!
XWiki- Java
PMWiki- PHP
- Ugly as shit
- MkDocs
- TiddlyWiki
- Okay I have spent an hour trying to get my head around this and while I think I got it I don't think its intuitive for us or a user.
- Performance wise tho, this thing is impressive
- Could be convinced, leaving it up
Quiki- "Anyone can read it. Anyone can write it." Bullshit. You invented a Go templating language, immediately ran into problems, then had to write a dedicated section on escaping those problems to write html.
- Absolutely not.
- MDwiki
- No longer maintained?
- FlatNotes
- Hugo theme: Relearn
- Vuepress
Docusaurus- Waayyyy too much npm for my peace of mind
- Facebook owned