Unofficial Resonite Documentation

Table of Contents

ToC

Why

This documentation(/wiki) got created in response to the Resonite Issue #1. Myself and a few involved in the linked issue think a static site generator is the better Wiki-Solution for complex software like resonite. While I personally understand the challenges and learning curve that comes with, I think it is still easier approach what is planned with the official Wiki.

Contribute

I just want to write

While I'm always happy see people trying, I don't want anyone to feel forced using Git and Markdown. If you just want to write something for this documentation without the shortcomings, feel free to shoot me a DM on Discord. My username is the.phil.. (If possible, please do not send me a friend request and rather contact me in DMs directly through the Resonite Discord Server.) You can send me anything unformatted and I will try my best to read your mind and make it pretty in Markdown ^^'

How it works

This documentation is using Docsify.JS with Markdown. To run the Wiki locally, please follow the Docsify.JS instructions. You need Node.JS installed on your workstation for the instructions to work.

Start command is docsify serve .

A deserved Thank you ^^

A deserved shout-out goes out to Banane9 for helping me to get all the color of the different data types as well as a detailed list of all the Protoflux nodes. Also big thankies go to Jae aka J4 for allowing us to use their work. It really helped to kick-start this documentation and get the ball rolling on how to structure it.

ToDo List

• NeosVR MediaWiki import
  • Get all XML files from all articles
  • Run Script and convert to Markdown files
  • Try different configurations on how to sort the articles
  • Complete manual import
  • Consolidate articles for repetitive content and use embedding/nesting of files
  • Decide on how to handle the new Resonite Wikis content. (Import then override?)
• Sidebar
  • Check, if it can be automated Can be automated with docsify-tools but it uses the filename instead of the first header or front matter info.
  • Write Script/Setup/Write manually
• Evaluate MediaWiki Template Support
  • embedding/nesting could work, might need script
  • Is possible: Add Docsify mustache for templating with variables
    • But needs to be tested, if vars are applied to embeds
• Add glossary plugin
• Fix Language fallback
• Test Tabs Plugin
• Decide on custom URL Routing for Ingame help Normal URLs can be used.
• Create Overrides to convert Githubs Markdown to Docsify.JS
  • Noticed on Alert and Info box syntax Fixed with plugin
• Evaluate if Navbar is needed: Navbar is needed for language changes and official links
• Import Jae's Wiki articles about Resonite
• Resonite Theming
• Create render plugin to display protoflux nodes with dynamic content.
• Create full list of a Protoflux nodes
• Hide drop shadow when sidebar is closed.
• Look into how to use Github Pages with Docsify
• Fix Light-Dark switcher overlapping with text on mobile.
• Make embedding partial content a thing