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

path to images in markdown, using placeholder like {imagefolder} #705

Open
aisbergde opened this issue May 25, 2020 · 0 comments
Open

path to images in markdown, using placeholder like {imagefolder} #705

aisbergde opened this issue May 25, 2020 · 0 comments

Comments

@aisbergde
Copy link
Contributor

aisbergde commented May 25, 2020

Expected Behavior

it should be possible to add links to images and the path should be flexible created depending on the place where the page is located.

Analog to translating [schemaname].[tablename] into the correct path

Current Behavior

I cant use relative path to images in markdown because the current folder of the generated html could be on a different path:

  • schema_abc
  • schema_abc/table_def

if a relative path is correct for one location it will be wrong for the other location

Possible Solution

the same issue is solved when using [schemaname].[tablename] or [tablename] in markdown: the generated path to the linked object is correct no matter where the document containing markdown is located.

Something similar is required for images.

For example there could be one folder containing the required images. Maybe D:\Tools\schemaspy\PerformanceAnalytics\images, maybe something different like D:\Tools\schemaspy\PerformanceAnalytics\customer_images

And in the markdown some special placeholder could be used, for example

![image 1]({imagefolder}\image_1.jpeg)

and this needs to be translated into a relativ path depending on the current folder

![image 1](..\customerimages\image_1.jpeg)
![image 1](..\..\customerimages\image_1.jpeg)

The idea could also be extended to use placeholders in a more general way. And a place is required where to define placeholders. Maybe program options are a simple way and compatible with the current configuration.

Or any other way which allow to store and use images inside the generated documentation.

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

No branches or pull requests

1 participant