Skip to content

Conversation

@oliverpauffley
Copy link

No description provided.

@Gulluth
Copy link
Contributor

Gulluth commented Nov 7, 2025

This is a neat change, I've not come across the mustache plugin for docsify before. My only concern is if @GraculusDroog will be able to work with the JSON files, so we would want a sign off from him before merging.

@oliverpauffley
Copy link
Author

oliverpauffley commented Nov 11, 2025

This is a neat change, I've not come across the mustache plugin for docsify before. My only concern is if @GraculusDroog will be able to work with the JSON files, so we would want a sign off from him before merging.

Still a work in progress but thanks for taking a look. That was going to be my question too.

Pros:

  • This would make it easy to add new beasts without worrying about typing out all the formatting.
  • It means if you want to write something that uses the beasts it's super easy to download this file.

Cons:

  • No one likes typing out json by hand.
  • If you wanted to add a new beast that didn't fit the format of the others, because it needs an extra box or something, then this will get in the way.

I will probably finish the work (at somepoint soon!) but yeah if it's a no go then let me know.

@Gulluth
Copy link
Contributor

Gulluth commented Nov 12, 2025

I think it is a really good idea, and it will make the code more portable. I just would hate to see you put in a lot of effort into a PR that ends up not being merged, so lets think this through.

+Pros:

  • The JSON has less markup then the embedded HTML and markdown.

+Cons:

  • JSON formatting bugs will cause worse rendering issues than bugs in HTML.
  • Leo is not a user of git, outside of using the github web UI to make minor modifications to the markdown and html.
  • I have considered moving away from docsify to another static site generator for i18n and SEO reasons. But no work has been done here, so this is vaporware.

How to fix these cons:

  • switch the main branch to develop, and add CI/CD to lint JSON before merging to main and deploying.
  • I first thought about adding a script to generate JSON, but I think the previous point on CI/CD actually would be a better solution, and I don't think @GraculusDroog will have any issues with formatting. I just don't want to force CLI git actions on Leo.
  • its possible mustache would be available in other SSG, making point 3 sort of moot.

@oliverpauffley
Copy link
Author

Some further cons:

  • The adult sandworm is an example where it doesn't have a level but hullpoints. I don't think this is easily handled by mustache but I can have a look.
  • I wonder if the rigidity is going to be a problem?

Maybe it's just one for the bin right now. It's all solvable with an API and database but then it's not very static :D

@oliverpauffley
Copy link
Author

I added more beasts but my parser didn't handle the ones with things like biological / synthetic so just need to fix that

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants