-
Notifications
You must be signed in to change notification settings - Fork 7
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
Add multiple page docs #31
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please adjust the image paths and make use of the video embedding.
|
||
This `About` section provides detailed information about the BIMS project. It offers insights into the project's objectives, purpose, and significance, helping users understand its scope and how it aims to address specific challenges. | ||
|
||
[![Home Page](./img/about-img-1.png)](./img/about-img-1.png) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why are all the images relative links in all the files?
Standard images in markdown would be: ![Image Name](path/to/image.png)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Jeremy-Prior, once Eli told me to do that to show the image content properly.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ketankartoza I'm going to need more of an explanation than that. Making images into links will not affect how the image displays on the site?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Jeremy-Prior, when we click on the image it will open that image in a new window in bigger size.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That seems unnecessary, but sure, leave it then. Just address the video embedding.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, it will look like that in VSCode, do a ./build-docs-html.sh and mkdocs serve to view the site on your local.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Jeremy-Prior It looks like the above image on my local after build but it's working fine on the live site. So for now I will update the video links on my local and will check once it merges.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay I will make it like that thanks
docs/src/user/manual/help.md
Outdated
|
||
* **Introduction to key FBIS components:** | ||
|
||
[![Dummy Image](./img/help-img-2.png)](https://www.youtube.com/watch?v=aex5tzLNWAo) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We are able to embed videos using the mkdocs-video
plugin using ![type:video](video_url.com)
.
Minor changes Co-authored-by: Jeremy-Prior <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
This Pr is for the issue #30