rsek
commented
2 years ago i appreciate the thought :) but i'm not sure it's practical for me to use this.
- i've got my own internal, nodejs-based script already (it generated the markdown file that's currently in the repo)
- the main thing my own script's output is missing is handling for some of the more complex tables that feature nesting and such (which your script appears to exclude anyways); resolving that is mainly a question of devising an acceptable way to render those in markdown. the most prominent example is the settlement name table (p. 178-179), something i want to approach with care to ensure that it conveys the table information effectively
- i'm working on including better-annotated, dataforged-compatible output in datasworn (and migrating datasworn's 'master' data to the idiosyncratic yaml notation i use to make the data entry and annotation more rsek-friendly). the end goal is being able to use the same tools to manage both repos, including rendering markdown table output. since i'm currently also revising Dataforged's format ahead of Starforged's release, this is a moving target (and it has to be, if i want a single format to be able to accurately represent both games)... and asking people who aren't psychic to hit that target isn't very fair to them ;) meanwhile, i know both formats and can write my script with migration in mind (and migration will be much quicker because i'm already familiar with it)
- rendering the markdown tables as a single file is intentional. partly because i can't think of a use case for split files (though maybe i'm missing something obvious), partly because i'm planning to change datasworn's 'default' oracle json to a single file containing all oracles
- the table of contents you generate is a nice thought, but it may be redundant: many markdown renderers automatically generate a TOC from the markdown heading hierarchy. github's web ux doesn't expose it especially well, but it's there:
however, if i've missed some nuance of your script (quite possible, as i'm not very familiar with python), please let me know. :)
BattleDrumz
I formatted them in a way that made sense, but let me know if you would prefer a different MD paradigm. I will finish up the other oracle files by the end of the week (whenever I can get around to working on them).