Add fields to disable sitemap.xml and robots.txt generation #2579
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Bromind
changed the title
Keats
requested changes
Jul 21, 2024
components/config/src/config/mod.rs
Outdated
| /// Disable the generation of Sitemap.xml | ||
| pub no_sitemap: bool, | ||
| /// Disable the generation of robots.txt | ||
| pub no_robots: bool, |
There was a problem hiding this comment.
Let's make those:
generate_sitemap
generate_robots_txt
with a default of true
There was a problem hiding this comment.
Implemented (see 63ef902).
…_sitemap (default to true)
Keats
requested changes
Jul 23, 2024
components/config/src/config/mod.rs
Outdated
| @@ -98,6 +98,10 @@ pub struct Config { | |||
| pub markdown: markup::Markdown, | |||
| /// All user params set in `[extra]` in the config | |||
| pub extra: HashMap<String, Toml>, | |||
| /// Disable the generation of Sitemap.xml | |||
| pub generate_sitemap: bool, | |||
| /// Disable the generation of robots.txt | |||
There was a problem hiding this comment.
Need to update the coomments
| generate_sitemap = false | ||
|
|
||
| # When set to "false", robots.txt is not generated (default: true) | ||
| generate_robots_txt = false |
There was a problem hiding this comment.
We use the default in the docs so set them to true
There was a problem hiding this comment.
My bad, I didn't look carefully at the docs. It should be correct by now.
…xt), now that the default is true and false is needed to disable
Keats
approved these changes
Jul 25, 2024
|
Thanks! |
reujab
pushed a commit
to reujab/zola
that referenced
this pull request
Aug 14, 2024
…2579) * Add feature to disable robots.txt and sitemap.xml from the config file. Addresses feature request getzola#2248 * Add documentation for no_sitemap & no_robots * Rename no_robots and no_sitemap into generate_robots_txt and generate_sitemap (default to true) * fix rustfmt issues * Change documentation to show defaults * Update documentation for the fields generate_sitemaps (resp. robots_txt), now that the default is true and false is needed to disable
Keats
pushed a commit
that referenced
this pull request
Aug 15, 2024
* Add feature to disable robots.txt and sitemap.xml from the config file. Addresses feature request #2248 * Add documentation for no_sitemap & no_robots * Rename no_robots and no_sitemap into generate_robots_txt and generate_sitemap (default to true) * fix rustfmt issues * Change documentation to show defaults * Update documentation for the fields generate_sitemaps (resp. robots_txt), now that the default is true and false is needed to disable
berdandy
pushed a commit
to berdandy/azola
that referenced
this pull request
Sep 17, 2024
…2579) * Add feature to disable robots.txt and sitemap.xml from the config file. Addresses feature request getzola#2248 * Add documentation for no_sitemap & no_robots * Rename no_robots and no_sitemap into generate_robots_txt and generate_sitemap (default to true) * fix rustfmt issues * Change documentation to show defaults * Update documentation for the fields generate_sitemaps (resp. robots_txt), now that the default is true and false is needed to disable
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Addresses feature request #2248
this simply adds two fields in
config.toml, one fieldno_sitemap, which disable the generation ofsitemap.xmlif set, and one fieldno_robots, which disable the generation ofno_robots.txtif set.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.
This feature is discussed in #2248 "We could make it a config.toml option." (Keats, July 2023) -> This is exactly what this PR implements
Sanity check:
Code changes
(Delete or ignore this section for documentation changes)
nextbranch?If the change is a new feature or adding to/changing an existing one: