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

[Question] Is there a way to have relative links between written docs? #1122

Closed
nrudnyk opened this issue Oct 21, 2019 · 4 comments
Closed

Comments

@nrudnyk
Copy link

nrudnyk commented Oct 21, 2019

As per title, is there a way to have relative links between written markdown?

e.g. I Have -- documentation: "guides/*.md" and I have the following files:

+-- guides
|   +-- Main.md
|   +-- Additional.md

and I want to reference Additional.md from Main.md. What is the proper way of doing that?
Or I should provide full relative html link which will be generated later?

@nrudnyk
Copy link
Author

nrudnyk commented Oct 21, 2019

Also, I'm interested if the images can be used from custom assets directory (how to use it if possible), or maybe I can use custom theme, which includes custom-theme/assets/img/ folder, and which is accessible in generated html.

@johnfairh
Copy link
Collaborator

You can use markdown link syntax -- you need to see what jazzy is naming the .html version of your .md and link to that, eg. in Main.md, eg.

...see [additional docs](additional.html) for more.

For images/other resources you need to manually copy them into the docs directory; see that same markdown syntax page for how to link to images.

@nrudnyk
Copy link
Author

nrudnyk commented Oct 22, 2019

ok, as I suspected, need to look the jazzy naming and use the end-result. Thanks.
(btw, that might be considered as feature somewhere in future, would be cool to use relative article naming)

Anyways. thanks for your time!

@johnfairh
Copy link
Collaborator

considered as feature

Agreed -- #775, #853.

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

2 participants