Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documentation: using mkdocs #54

Merged
merged 1 commit into from
Jun 19, 2023

Conversation

marianfoo
Copy link
Contributor

@marianfoo marianfoo commented Jun 15, 2023

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
Copy link
Owner

Thx for the submission, I will double check that !

Copy link
Owner

@ArnaudBuchholz ArnaudBuchholz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New to me but willing to try !

@ArnaudBuchholz ArnaudBuchholz merged commit aedfea1 into ArnaudBuchholz:main Jun 19, 2023
@marianfoo
Copy link
Contributor Author

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
Copy link
Owner

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

@ArnaudBuchholz
Copy link
Owner

I like the result, thx again !

@marianfoo
Copy link
Contributor Author

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

@ArnaudBuchholz
Copy link
Owner

Done !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants