ArnaudBuchholz / ui5-test-runner

A test runner for UI5 applications enabling parallel execution of tests.
https://arnaudbuchholz.github.io/ui5-test-runner/
MIT License
18 stars 9 forks source link

documentation: using mkdocs #54

Closed marianfoo closed 1 year ago

marianfoo commented 1 year ago

Using Material for Mkdocs to visualize the documentation better:

To view docs locally run from root: docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material. open http://localhost:8000/ui5-test-runner/

image

Settings --> Pages

image

Under Settings --> Actions --> General

image

Show in About section

I also would suggest showing the URL to the documentation in the about section of the repo like here:

image
ArnaudBuchholz commented 1 year ago

Thx for the submission, I will double check that !

marianfoo commented 1 year ago

Thanks, i used it for my Excel Upload Component but adopted it from Ui5 tooling. They use the same setup. Now you can setup the pages to run from the branch gh-pages

ArnaudBuchholz commented 1 year ago

gotcha ! I was wondering where this was coming from but it is generated by the tool.

ArnaudBuchholz commented 1 year ago

I like the result, thx again !

marianfoo commented 1 year ago

Looks good! You can add the url to the About section to your GitHub Repo, so it's better visible.

ArnaudBuchholz commented 1 year ago

Done !