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

docs: fix overview example link #1786 #1811

Merged
merged 3 commits into from
Mar 29, 2022

Conversation

brleinad
Copy link
Contributor

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:

  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?

Code changes

(Delete or ignore this section for documentation changes)

  • Are you doing the PR on the next branch?

If the change is a new feature or adding to/changing an existing one:

  • Have you created/updated the relevant documentation page(s)?

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/

@brleinad brleinad requested a review from Keats March 28, 2022 17:37
@@ -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>
Copy link
Collaborator

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

Copy link
Contributor Author

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.

Copy link
Collaborator

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.

@brleinad brleinad requested a review from Keats March 28, 2022 21:50
@Keats Keats merged commit b8342e7 into getzola:master Mar 29, 2022
@brleinad brleinad deleted the docs/fix-github-deploy-1786 branch March 29, 2022 17:39
mattico pushed a commit to mattico/zola that referenced this pull request May 23, 2022
* docs: fix overview example link

* docs: use get_url to track section

* docs: ignore get_url in example
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.

Getting started example does not properly deploy to github pages
2 participants