-
Notifications
You must be signed in to change notification settings - Fork 990
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
docs: fix overview example link #1786 #1811
Conversation
@@ -219,7 +219,7 @@ The `index.html` file inside the `templates` directory should be: | |||
<h1 class="title"> | |||
This is my blog made with Zola. | |||
</h1> | |||
<p>Click <a href="/blog/">here</a> to see my posts.</p> | |||
<p>Click <a href="{{ get_url(path="@/blog/_index.md") }}">here</a> to see my posts.</p> |
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.
My bad it should be {{/* get_url(path="@/blog/_index.md") */}}
to avoid zola trying to load it
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.
Ah good catch, thanks! I've changed this.
While serving the docs locally I noticed 4 broken anchors.
I think that the anchors are broken because the headings have a /
and this character is not stripped for the slugs. Should this be added to the list of characters? I can open a new issue and PR for this. I'm really liking Zola and I'm looking for ways to help out.
> Checked 79 internal link(s) with anchors: 4 target(s) missing.
Error: The anchor in the link `@/themes/papaya/index.md#postproject-date-formats` in /Users/danielrb/open/zola/docs/content/themes/papaya/index.md does not exist.
The anchor in the link `@/themes/papaya/index.md#postproject-featured-images` in /Users/danielrb/open/zola/docs/content/themes/papaya/index.md does not exist.
The anchor in the link `@/themes/papaya/index.md#open-graph-protocol-localeprofile-information` in /Users/danielrb/open/zola/docs/content/themes/papaya/index.md does not exist.
The anchor in the link `@/themes/papaya/index.md#socialcontact-links` in /Users/danielrb/open/zola/docs/content/themes/papaya/index.md does not exist.
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 should ignore errors in themes directory since it's essentially coming from GitHub READMEs and their slugification differs from Zola so we might always have broken intra-links.
I can't remember if that's possible yet or not though.
* docs: fix overview example link * docs: use get_url to track section * docs: ignore get_url in example
IMPORTANT: Please do not create a Pull Request adding a new feature without discussing it first.
The place to discuss new features is the forum: https://zola.discourse.group/
If you want to add a new feature, please open a thread there first in the feature requests section.
Sanity check:
Code changes
(Delete or ignore this section for documentation changes)
next
branch?If the change is a new feature or adding to/changing an existing one:
This PR fixes #1786
I tested it by forking the repo and deploying to github pages
https://github.com/brleinad/zola-repro-1
https://brleinad.github.io/zola-repro-1/