Prevent generating folder & index.html for a specific page when "rendes = false" #2318

endesigner · 2023-09-25T10:16:04Z

Adds front matter flag to prevent generation of page folder & index.html
discussion

Sanity check:

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

Code 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)?

#1356 may be related even though front matter flag that this feature provides must be applied to every page rather than whole section.

fixed getzola#2195

* Reuse Client when checking urls and add timeout for requests

* Implement replace_re filter * Cargo fmt * add regex caching * cargo fmt * update docs, update unit test * rename replace_re -> regex_replace

Relative links in the entry content do not currently have a base URI, so will be resolved relative to the feed URI: Given an entry with the content: <a href="some-resource.bin"> And URIS of: * entry: https://example.org/blog/some-entry/ * feed: https://example.org/atom.xml The link URI will end up as: https://example.org/some-resource.bin rather than the URI that ends up resolved in the rendered page: https://example.org/blog/some-entry/some-resource.bin The atom and RSS formats allow for an xml:base attribute (itself specified in [1]) to provide a base URI of a subset of a document. This change adds xml:base attributes to each entry, using the page permalink. This gives us something equivalent to: <entry> <content xml:base="https://example.org/blog/some-entry/"> <![CDATA[ <a href="some-resource.bin"> ]]> </content> </entry> [1]: https://www.w3.org/TR/xmlbase/ Signed-off-by: Jeremy Kerr <[email protected]>

* Fix multi-ligual json index * multi-lingual search Fix cargo fmt

…tzola#2196) * Add search into the serialized config (getzola#2165) * Only expose index_format * Create config.search struct * cargo fmt

* Fix hard link panic and add better error info to std:fs errors * cargo fmt * Remove erroneously committed config change * Remove console import; Use with context to provide additional error info * improve error wording

* Add optional decoding="async" loading="lazy" for img In theory, they can make the page load faster and show content faster. There’s one problem: CommonMark allows arbitrary inline elements in alt text. If I want to get the correct alt text, I need to match every inline event. I think most people will only use plain text, so I only match Event::Text. * Add very basic test for img This is the reason why we should use plain text when lazy_async_image is enabled. * Explain lazy_async_image in documentation * Add test with empty alt and special characters I totaly forgot one can leave the alt text empty. I thought I need to eliminate the alt attribute in that case, but actually empty alt text is better than not having an alt attribute at all: https://www.w3.org/TR/WCAG20-TECHS/H67.html https://www.boia.org/blog/images-that-dont-need-alternative-text-still-need-alt-attributes Thus I will leave the empty alt text. Another test is added to ensure alt text is properly escaped. I will remove the redundant escaping code after this commit. * Remove manually escaping alt text After removing the if-else inside the arm of Event::Text(text), the alt text is still escaped. Indeed they are redundant. * Use insta for snapshot testing `cargo insta review` looks cool! I wanted to dedup the cases variable, but my Rust skill is not good enough to declare a global vector.

…atter (getzola#2237) * Prevent spans crossing line boundaries in class formatter * Add snapshot tests for classed highlighting

* sort page.assets by filename Uses .to_str() to sort files and subfolders. The .unwrap() may need work or be replaced by unwrap_or_default(). Given earlier checks in the function it should work however. * add tests for assets sorting * fix rustfmt * use existing loop instead of windows * also check the non-recursive test * use .zip() and add assert msg

* templates:atom: add support for multiple authors Atom 1.0 [0] support multiple `<author>` entries in the feed. This commit modified the template to generate as many `<author>` as the page's metadata contains. [0] https://validator.w3.org/feed/docs/atom.html#recommendedEntryElements * Test we can have multiple authors in ATOM feeds

The `rel` and `type` HTML attributes are needed in the `base_url` (or `section.permalink`) link so feed aggregators know that's the HTML page that corresponds to the atom feed. Note: The RSS template doesn't have this issue.

…fig file not present (getzola#2262)

* use fs canonicalize to prevent path traversal * fix cargo fmt

* Add ignored_static to config * Make handle ignored static files correctly * cargo fmt * Match on relative path rather than incorrect target path * path -> partial path for serve static ignore * remove debug println * copy static directory if there is no ignored globset * Update docs * Deduplicate code with additional Option argument * cargo fmt

* template:feeds: add extra block * add missing > * Revert "add missing >" This reverts commit 45c6b9c. * Revert "template:feeds: add extra block" This reverts commit 596f7f1. * Update docs for feed templates

) * Introduce option to force directory when running the serve command * Update documentation about the force flag on the serve command * Resolve cargo fmt issue * Reword new serve flag documentation

…etzola#2287) The warning about unknown highlight languages was displayed even when code highlighting was disabled via `markdown.highlight_code = false`. This commit adds a condition to check this setting before issuing the warning, effectively suppressing it when code highlighting is disabled. Issue: getzola#2280

* Fixed "unnecessary mut" warning * Fixed minor typo * Use more than 8 threads for links checking if hardware supports it * Fixed failing azure Linux check * Avoid unnecessary HTTP requests to the same, already checked links

endesigner · 2023-09-25T14:12:23Z

Any clue on the discrepancy of test runners?

Keats · 2023-09-26T20:08:53Z

Not entirely sure

Keats · 2023-09-26T20:12:22Z

components/content/src/page.rs

@@ -115,6 +115,10 @@ impl Page {
 page.word_count = Some(word_count);
 page.reading_time = Some(reading_time);

+ if !page.meta.render {


Do we want to still process slugs etc even if we don't render things?

Hi Keats,

No, my intention was to stop processing of slugs, paths and sitemap entries if meta.render is set.

I assumed that, since parse() returns at this point, the job is done but your question makes me doubt that :) I'm not fluent in the codebase (or Rust for that matter) so if there are any other places where I should do the plugging please let me know.

It's mostly a question of whether we want a fully populated page, except it's not rendered which I think is better?

I think it's probably better to have the fully processed pages so if you query it in a template, you have all the info you need

Keats · 2024-05-09T21:31:17Z

Something funky happened to the PR, can you rebase? Otherwise i'll take the commit directly on next

Keats and others added 25 commits March 19, 2023 20:37

Next version

8d16d17

print error message when no config file found (getzola#2168)

b00ae42

fixed getzola#2195

Speedup "zola check" command by reusing the Client (getzola#2171)

1ed722c

* Reuse Client when checking urls and add timeout for requests

Implement replace_re filter (getzola#2163)

6a5c241

* Implement replace_re filter * Cargo fmt * add regex caching * cargo fmt * update docs, update unit test * rename replace_re -> regex_replace

Fix multi-lingual json index (getzola#2197)

7edf92b

* Fix multi-ligual json index * multi-lingual search Fix cargo fmt

Add search.index_format into the serialized config (getzola#2165) (ge…

7448309

…tzola#2196) * Add search into the serialized config (getzola#2165) * Only expose index_format * Create config.search struct * cargo fmt

Fix typo in error message

4f77980

Hard link serve panic fix (getzola#2210)

1321a83

* Fix hard link panic and add better error info to std:fs errors * cargo fmt * Remove erroneously committed config change * Remove console import; Use with context to provide additional error info * improve error wording

Prevent spans crossing line boundaries in class-based code block form…

1778707

…atter (getzola#2237) * Prevent spans crossing line boundaries in class formatter * Add snapshot tests for classed highlighting

Fixes getzola#2250; Error instead of panic when root directory or con…

d3793cd

…fig file not present (getzola#2262)

Fix LFI in zola serve (getzola#2258)

fe1967f

* use fs canonicalize to prevent path traversal * fix cargo fmt

Update changelog

b97a1d5

Update edition

f0b984d

Update deps

57968be

template:feeds: add extra block (getzola#2263)

4474afa

* template:feeds: add extra block * add missing > * Revert "add missing >" This reverts commit 45c6b9c. * Revert "template:feeds: add extra block" This reverts commit 596f7f1. * Update docs for feed templates

Add Checking and Force Flag for Directory in Serve Command (getzola#2265

e81e139

) * Introduce option to force directory when running the serve command * Update documentation about the force flag on the serve command * Resolve cargo fmt issue * Reword new serve flag documentation

Clippy

2da4981

endesigner force-pushed the next branch 4 times, most recently from c0805b2 to 20900d3 Compare September 25, 2023 11:52

Prevent generating folder & index.html for a specific page

fead0f1

endesigner force-pushed the next branch from 20900d3 to fead0f1 Compare September 26, 2023 08:31

Keats reviewed Sep 26, 2023

View reviewed changes

Keats force-pushed the next branch from 7f5d1a6 to e5f3026 Compare December 19, 2023 12:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Prevent generating folder & index.html for a specific page when "rendes = false" #2318

Prevent generating folder & index.html for a specific page when "rendes = false" #2318

endesigner commented Sep 25, 2023

endesigner commented Sep 25, 2023

Keats commented Sep 26, 2023

Keats Sep 26, 2023

endesigner Sep 30, 2023

Keats Oct 8, 2023

Keats Nov 20, 2023

Keats commented May 9, 2024

Prevent generating folder & index.html for a specific page when "rendes = false" #2318

Are you sure you want to change the base?

Prevent generating folder & index.html for a specific page when "rendes = false" #2318

Conversation

endesigner commented Sep 25, 2023

Code changes

endesigner commented Sep 25, 2023

Keats commented Sep 26, 2023

Keats Sep 26, 2023

Choose a reason for hiding this comment

endesigner Sep 30, 2023

Choose a reason for hiding this comment

Keats Oct 8, 2023

Choose a reason for hiding this comment

Keats Nov 20, 2023

Choose a reason for hiding this comment

Keats commented May 9, 2024