decker-edu / decker

A markdown based tool for slide deck creation.
GNU General Public License v3.0
53 stars 13 forks source link

Document config / meta variables #110

Open salbeira opened 4 months ago

salbeira commented 4 months ago

If you want to know what you can configure you need to either look into the code of a plugin, look into some test-deck that might be related to what you are looking for or just hope that someone tells you. While I added some documentation about available meta-variables in the german-user-guide (currently a more complete version is available at https://decker.cs.tu-dortmund.de/decks/decker/manual/) I also am still not sure I actually found all of them.

If you would be so kind to add any information and documentation about variables to the skeleton.yaml file in the develop branch we could have some documentation available there.

In addition, there are still some test-values and test-variables inside the default.yaml file. I know these are necessary for certain test-decks (like the meta-resources-deck ... which is already a bit broken by some variables missing) but I would propose that we add some file like "test.yaml" that gets merged with the default.yaml only if we run a local test with stack run -- --server in the local directory (similar to how we detect this with the "THIS IS A DEV RUN" message we introduced while fixing #39 ) May be related to #87