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

Fix incorrect documentation for syntax directory #1901

Merged
merged 1 commit into from
Jun 16, 2022

Conversation

nyanpasu64
Copy link
Contributor

Currently the Configuration docs says to load syntax files into config.toml [markdown] extra_syntaxes. However, ever since 23064f5 (released in Zola v0.15.0), the extra_syntaxes property was replaced by extra_syntaxes_and_themes, and used as both syntax and color theme search paths. Following the docs and trying to set the extra_syntaxes property does nothing, and #1723 ran into this issue.

Change the docs to consistently reference extra_syntaxes_and_themes.

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)

Should this be merged into next or master? If merged directly into master (to edit live docs), you need to cherry-pick #1606 as well, since that PR partly fixed the docs and this fixes the remaining errors.

Currently the Configuration docs says to load syntax files into
config.toml [markdown] extra_syntaxes. However, ever since commit
23064f5 (released in Zola v0.15.0), the extra_syntaxes property was
replaced by extra_syntaxes_and_themes, and used as both syntax and color
theme search paths. Following the docs and trying to set the
extra_syntaxes property does nothing, and getzola#1723 ran into this issue.

Change the docs to consistently reference extra_syntaxes_and_themes.
@Keats
Copy link
Collaborator

Keats commented Jun 16, 2022

It's ok on next, the next release is not that far away.

Copy link
Collaborator

@Keats Keats left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@Keats Keats merged commit 72243d9 into getzola:next Jun 16, 2022
theowenyoung added a commit to theowenyoung/zola that referenced this pull request Jul 8, 2022
* 'next' of github.com:getzola/zola:
  Apply orientation transformation based on EXIF data (getzola#1912)
  Stop printing invalid files in dirs
  fix windows EOL in markdown files (getzola#1911)
  Properly escape anchor names (getzola#1908)
  Allow new lines before anchor (getzola#1905)
  Fix incorrect documentation for syntax directory (getzola#1901)
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.

2 participants