Can this be customized more?

[Andre601]

I was wondering, if there are more options to customize this more.
For example do I use the Material Theme v5.0.0 (RC 4) with PyMdown 7 and was wondering if this can be used using those versions and extensions.

[mhausenblas]

I was wondering, if there are more options to customize this more.

Totally doable. I'm wondering how to go about it, tho, from an UX perspective. Any suggestions @Andre601?

[Andre601]

I'm no expert with this, so I can't really tell what a good way would be to do this.

[mhausenblas]

@Andre601 gotcha and just to be clear, I didn't mean how to implement it but how would you see it from the usage perspective. How would you want to customize the action? There are many options I can think of, from simple environment variables for, say the Material Theme version to a well-known location for a config folder, etc.

So my question really was: how would you prefer to customize (and ideally a comprehensive list of things you want to customize) it, without thinking of the implementation. Hope this makes sense?

[Andre601]

Yeah it does.
I think a dedicated file in the same folder as the workflow directory (in the .github folder) would be a good option imo.

[Andre601]

I saw that this action seems to accept a requirements.txt?
In that case, what is that file for and what could I implement into it?

[runningcode]

Maybe what we need here is just a little note in the README of this repo saying that you can use a requirements.txt file in the root of your github repository.

@Andre601 Inside requirements.txt you can list

mkdocs-material>=5.1.0
pymdown-extensions>=7.0

[Andre601]

Mentioning mkdocs-material>=5.1.0 is more than enough as it always includes the latest PyMdown extensions

[runningcode]

Unfortunately, it fails to compile:
https://github.com/runningcode/fladle/pull/111/checks?check_run_id=672199019
You can see the mkdocs-material>=5.1.0 material in the requirements.txt
https://github.com/runningcode/fladle/pull/111/files#diff-b4ef698db8ca845e5845c4618278f29aR2

[Andre601]

Unfortunately, it fails to compile:
https://github.com/runningcode/fladle/pull/111/checks?check_run_id=672199019
You can see the mkdocs-material>=5.1.0 material in the requirements.txt
https://github.com/runningcode/fladle/pull/111/files#diff-b4ef698db8ca845e5845c4618278f29aR2

VersionConflict: (mkdocs 1.0.4 (/usr/local/lib/python3.6/site-packages/mkdocs-1.0.4-py3.6.egg), Requirement.parse('mkdocs>=1.1'
The action downloads mkdocs 1.0.4 while it should be 1.1, so I think mentioning that in the requirements.txt instead of just mkdocs should fix it?

I myself currently use a custom workflow for pushing changes, which works fine with just having mkdocs-material>=5.0.0 in the requirements file.

https://github.com/Andre601/mkdocs-template/blob/master/.github/workflows/deploy.yml
https://github.com/Andre601/mkdocs-template/blob/master/requirements.txt

[runningcode]

My workaround was to use mhausenblas/mkdocs-deploy-gh-pages@fac2eec84aaa3d3de08f0eeb835b1b3f0dfbaa60 instead of mhausenblas/mkdocs-deploy-gh-pages@1.11

[ghost]

Hey @runningcode I just took a look at the issues and I believe adding the nomaterial branch should resolve this. (Use it by referencing mhausenblas/mkdocs-deploy-gh-pages@nomaterial.) Could you please re-test?