Use a different file than README.md for generating documentation

[leoweigand]

trafficstars

First of all, thank you @jeromegn for this awesome tool / service. I think it would make sense for DocumentUp to have an option to generate the docs from another file than README.md, like DOCS.md, as one may want to keep the README file small or to contain other information than the whole docs.

I imagine something like:

name: DocumentUp
file: DOCS.md

Could of course also be filepath or something similar.

Another question not worth opening a separate issue for: is it possible to use .documentup.json instead of .documentup.yml? I saw this in https://github.com/wout/svg.js.

[jeromegn]

Hey there,

Technically, you can already do something like that by using documentup.com/username/repo/path/to/markdown/file

However, it's not yet possible to change the root file being rendered. I will be possible though :) Def on the roadmap.

You can use a .documentup.json file but it's sort of deprecated. Is there a reason for this? Right now DocumentUp will work with 3 different file names for the configuration, but yaml is faster, simpler to write in my opinion. It's also less error prone.

[leoweigand]

Alright that will be a good workaround until it is possible to change the root file. No reason for json at all, yaml is fine. I was just curious.