Commit graph

737 commits

Author SHA1 Message Date
TrialDragon
18d28b7096
Fix typo in Fedora installation instructions (#2440) 2024-02-18 21:58:11 +01:00
Vincent Prouillet
cec01e6f48
Update themes gallery (#2425)
Co-authored-by: GitHub Action <action@github.com>
2024-02-04 22:39:07 +01:00
Vincent Prouillet
4a56c068e0
Update themes gallery (#2406)
Co-authored-by: GitHub Action <action@github.com>
2024-01-22 10:16:15 +01:00
Leonid Tsarev
b89837a2cb
Update installation.md to add winget command (#2413) 2024-01-21 17:50:43 +01:00
Yuanlin Lin
9fe455892e
Add Zeabur deployment guide (#2408)
* Add Zeabur deployment guide

* Select Zola version in Zeabur deployment
2024-01-15 09:49:25 +01:00
Yusuf Cihan
b3c9529089
Add more information about Vercel deployments (#2399)
* Add more information about Vercel

* Change wording and add specify version

* Update vercel.md
2024-01-07 14:19:05 +01:00
Javier Pérez
38199c1255
Update the GitLab Pages documentation (#2384)
* docs: update gitlab-pages.md

* docs: rephrase sentence

* docs: add clarification

* docs: fix formatting

* docs: add link to gitlab docs

* docs: update gitlab-pages-md

* docs: refactor gitlab-pages.md
2023-12-21 12:34:16 +01:00
Vincent Prouillet
f560b48f43 Remove dummy file 2023-12-18 23:24:06 +01:00
SquirrelHub
8b2b066e64 Add Checking and Force Flag for Directory in Serve Command (#2265)
* 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
2023-12-18 23:24:06 +01:00
Heitor
841b3dfc92 template:feeds: add extra block (#2263)
* template:feeds: add extra block

* add missing >

* Revert "add missing >"

This reverts commit 45c6b9c6eb.

* Revert "template:feeds: add extra block"

This reverts commit 596f7f1e7f.

* Update docs for feed templates
2023-12-18 23:24:06 +01:00
Andrew Langmeier
4430515a02 Add ignored_static to config (#2209)
* 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
2023-12-18 23:24:06 +01:00
sinofp
22dc32a589 Add support for lazy loading images (#2211)
* 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.
2023-12-18 23:24:06 +01:00
‏‏Dave
c61e925073 Implement replace_re filter (#2163)
* Implement replace_re filter

* Cargo fmt

* add regex caching

* cargo fmt

* update docs, update unit test

* rename replace_re -> regex_replace
2023-12-18 23:24:06 +01:00
Vincent Prouillet
d4d0e4b02a Update syntax highlighting recc 2023-12-17 23:47:03 +01:00
Javier Pérez
8276551811
Update syntax-highlighting.md (#2366) 2023-12-09 21:35:57 +01:00
Spencer Scorcelletti
c031cc592c
Update documention for using zola + Cloudflare Pages per advice in https://github.com/cloudflare/pages-build-image/issues/3#issuecomment-1646873666 (#2364) 2023-11-30 23:14:57 +01:00
Vincent Prouillet
2774d4d410
Update themes gallery (#2356)
Co-authored-by: GitHub Action <action@github.com>
2023-11-13 10:29:04 +01:00
Vincent Prouillet
a7ffb3be81
Update themes gallery (#2349)
Co-authored-by: GitHub Action <action@github.com>
2023-11-04 20:03:29 +01:00
One
7d5ce5c230
Document author (#2347)
* Add author to documentation for config.toml

* Add explanation of how author is used for feeds
2023-10-30 19:03:29 +01:00
c-git
152eccc447
Change to updated version of checkout action (#2340) 2023-10-29 19:45:04 +01:00
Olivier Samyn
0b46736aff
Add multi-stage dockerfile build example (#2327)
* Add multi-stage dockerfile build example

* Simplify install instructions, add docker image deployment example
2023-10-21 22:38:17 +02:00
Vincent Prouillet
9097703b51
Update themes gallery (#2322)
Co-authored-by: GitHub Action <action@github.com>
2023-10-18 13:30:26 +02:00
Rik Huijzer
4f9158f6af
docs: show that base_url should contain protocol (#2328) 2023-10-16 08:51:23 +02:00
Vincent Prouillet
a49af5fa48
Update themes gallery (#2309)
Co-authored-by: GitHub Action <action@github.com>
2023-09-22 11:07:16 +02:00
dxvsh
0a8b2b410a
Fix the link to the author's site (#2313) 2023-09-19 21:41:45 +02:00
Peter Todorov
fc98cafe4a
docs: added aws s3 deployment instructions page (#2299)
* docs: added aws s3 deployment instructions page

* docs: fixed a typo in AWS S3 docs
2023-09-13 21:13:06 +02:00
n0xas
97d74b78b7
docs: update gitlab page deployment (#2292)
Co-authored-by: romain dusson <romain.dusson@alterway.fr>
2023-09-06 22:26:38 +02:00
Oscar Dominguez
e5e1a2fdac
docs: update links to new Tera docs URL (#2289)
More context here: https://github.com/Keats/tera/issues/854#issuecomment-1698901568
2023-08-31 14:32:36 +02:00
Alex Rutar
e6fe81cdf3
fix broken link to Tera (#2286) 2023-08-29 22:18:45 +02:00
Steven Roose
49b56c3026
docs: Update installation.md to use --locked (#2284) 2023-08-24 21:08:37 +02:00
Vincent Prouillet
9ae7d15139
Update themes gallery (#2279)
Co-authored-by: GitHub Action <action@github.com>
2023-08-21 17:31:33 +02:00
Vincent Prouillet
e727f43fe0 Fix link to tera 2023-08-20 14:29:06 +02:00
Vincent Prouillet
08c218d22a Add CNAME file 2023-08-20 12:53:41 +02:00
Óscar
74056d15ab
fix: styling conflict for code tags in li elements (#2273) 2023-08-15 21:49:45 +02:00
Dan Søndergaard
695c17d222
Add deployment tutorial for fly.io (#2252) 2023-07-23 17:13:02 +02:00
FineFindus
f93bd90020
docs(deploy-gh-pages): add workflow permissions (#2249) 2023-07-18 14:59:29 +02:00
Vincent Prouillet
d0ffb90f70
Update themes gallery (#2244)
Co-authored-by: GitHub Action <action@github.com>
2023-07-12 22:07:05 +02:00
Kot
a6bf8765a1
Clarify public dir in directory structure doc page (#2238) (#2240)
* Clarify `public` dir (#2238)

* Add `zola serve` to `public` dir description

* Move and rewrite `public` clarification
2023-07-06 16:06:15 +02:00
mehmetcan
11ca3666d0
update zola version (#2179) 2023-06-12 13:03:33 +02:00
Vincent Prouillet
5f4b95075a
Update themes gallery (#2220)
Co-authored-by: GitHub Action <action@github.com>
2023-06-12 13:02:53 +02:00
Aonghus Storey
864740a76f
docs: correct example use of Github GraphQL (#2230)
Fixes #2229
2023-06-09 17:55:32 +02:00
John Emhoff
d149afe07c
Shortcode documentation update (#2227)
* Details about using shortcodes

Explain how shortcodes differ from Tera template function calls

* Add path search order to image processing docs

I understand this is somewhat of an implementation detail, but it's required knowledge when you're trying to figure out why zola can't find your image.

* Update shortcodes.md

Drive home that shortcodes are completely unrelated to Tera

* Update shortcodes.md

Good grammar speak
2023-06-06 00:05:07 +02:00
Hildeberto Mendonça
0f819fc880
Using cargo install (#2218)
The tool is automatically built and added to the path when using `$ cargo install --path .`. It simplifies running Zola from the source.
2023-05-23 21:02:26 +02:00
Hildeberto Mendonça
e43b27e658
Documented CNAME file for custom domains (#2219) 2023-05-23 21:01:38 +02:00
Henri E. Francois
14f695e682
Clarifying documentation around themes. (#1541)
- Defined a theme in Zola
 - Clarified configuration of themes
 - Clarified theme template functionality
2023-05-19 12:44:40 +02:00
Connor Skees
252f3b3136
remove libsass from build instructions (#2217) 2023-05-17 09:25:01 +02:00
Xavier Béguin
7b095e4ccb
Complete output for get_taxonomy in the documentation (#2204)
Complete the documentation for the output of the tera function
`get_taxonomy` to include the `lang` and `permalink` overlooked fields.

Co-authored-by: Xavier B <>
2023-05-03 21:54:57 +02:00
Vincent Prouillet
2b56bcb967
Update themes gallery (#2203)
Co-authored-by: GitHub Action <action@github.com>
2023-04-30 22:03:30 +02:00
ryunix
3e215e6e28
Fix typo in page.md (#2192) 2023-04-27 15:56:44 +02:00
OneDragon424
d3fec80de1
docs: update expired Documents documentation (#2185)
Due to Cargo.toml:54-55 has change this feature from
  `search/indexing-ja/zh` into `indexing-ja/zh`
2023-04-20 13:55:44 +02:00
Vincent Prouillet
0113a73551
Update themes gallery (#2180)
Co-authored-by: GitHub Action <action@github.com>
2023-04-17 16:59:14 +02:00
Paul Sanders
0f21270bf1
Update deploy action to the latest version and make version consistant (#2173) 2023-04-10 17:54:19 +02:00
Vincent Prouillet
d626ea1c2e Update docs 2023-04-04 15:04:17 +02:00
Felix Wirth
b5dc5d847c
minor updates to overview docs (#2158) 2023-04-02 22:40:33 +02:00
lfxgroove
ef45bb78b0
Update documentation for multilingual use of taxonomies (#2157) 2023-04-02 22:36:01 +02:00
Vincent Prouillet
ce0a0bbcd3 Clarify some doc 2023-03-09 10:16:25 +01:00
Vincent Prouillet
5df6b8b4e7 Clarify some doc 2023-03-09 10:16:14 +01:00
Vincent Prouillet
66734b52e4 Update links to tmtheme editor
Closes #2114
Closes #2061
2023-03-08 22:58:20 +01:00
Cyril Marpaud
ce57d37147
fix: add "slug" where it was forgotten (#2132) 2023-03-08 22:27:51 +01:00
Waldir Pimenta
1538a38bf0
installing-and-using-themes.md: Change placeholder format for git repo URL (#2128)
The all-caps syntax makes it seem like an environment variable.
Changing to angle brackets makes it more evident that this is a placeholder value to be replaced when running the actual command.
2023-03-05 20:41:06 +01:00
Waldir Pimenta
f2d6b2e1d3
installation.md: add Nix installation instructions (#2126) 2023-03-05 20:32:22 +01:00
Vincent Prouillet
f45c1b601a It was actually correct? 2023-03-05 20:23:36 +01:00
Vincent Prouillet
e39dbb3afa
Use default search engine output
Closes #2123
2023-03-01 15:16:24 +01:00
Vincent Prouillet
1a6c1a32be Fix docs
Closes #2117
2023-02-26 20:01:04 +01:00
Vincent Prouillet
64feaeb3ee Pass section.generate_feed 2023-02-24 22:20:26 +01:00
Vincent Prouillet
c67655e29f Fix colocated assets in content directory
Closes #2101
2023-02-24 22:20:26 +01:00
Arjen
5f90ad1d33
Fix typo in pages-sections.md (#2115) 2023-02-24 15:54:54 +01:00
Seth Morabito
f4a1e99b98 Page and config authors (#2024) (#2092)
The W3C feed validator fails to validate RSS 2.0 and Atom 1.0 feed
elements that do not contain a valid author. This change adds an
`authors: Vec<String>` to pages, as well as an `author: Option<String>`
to Config that will act as a default to use in RSS and Atom templates if
no page-level authors are specified.
2023-02-16 20:49:03 +01:00
Vincent Prouillet
8ba6c1c2a1 Procimage refactor (#2086)
* Refactor image proc

Closes #2066

* Add colocated_path to shortcodes

Closes #1793
2023-02-16 20:49:03 +01:00
Vincent Prouillet
a56e4248e1 Remove built-in shortcodes
Bazooka way of fixing #1832
2023-02-16 20:49:03 +01:00
Vincent Prouillet
fcbb21abca Replace libsass by grass
Closes #1535
Closes #2022
2023-02-16 20:49:03 +01:00
David Reed
a7433a58d5 Expose markdown config property to templates (#2052)
* Expose the markdown config property to templates

* Document additional strategies for linking code-highlight stylesheets
2023-02-16 20:49:03 +01:00
magikstm
f2072fa0b6 Add details in the doc on CommonMark extension (#2034)
* Add details in the doc on CommonMark extension

* Update overview.md
2023-02-16 20:49:03 +01:00
magikstm
ebdeda11d6 Small update to the docs for get_url (#2033)
Small update to the doc linked to the discussion on #2026.
2023-02-16 20:49:03 +01:00
Felix Zwettler
d0b80654d1 add preserve_dotfiles_in_output configuration option (#1985) 2023-02-16 20:49:03 +01:00
Sosthene
7000f787b3 Search json index (#1998)
* search: Add support for a JSON index

* docs: Document JSON index for search

* docs: Use lazy-loaded JSON index

* Add elasticlunr prefix to search engine format configuration

This will be useful if support for more search libraries are added in the future
2023-02-16 20:49:03 +01:00
n-tux-tmp
baa473ceea add get_hash function (#1962)
Co-authored-by: Newbyte <newbie13xd@gmail.com>
Co-authored-by: n-tux-tmp <n-tux-tmp@example.com>
Co-authored-by: n-tux-tmp <n-tux-tmp@noreply.example.org>
2023-02-16 20:49:03 +01:00
Yaroslav
88433b6677 Add flag to override prompt for existing dir (#1986)
* Add flag to override prompt for existing dir

Added --force flag to build subcommand.

* Remove unnecessary 'force' check

* Remove prompt to overwrite directory on build cmd
2023-02-16 20:49:03 +01:00
bemyak
aecbc10c9b Add sorting by slug (#1926) 2023-02-16 20:49:03 +01:00
Eric Scouten
5fb0867b3a Get term fn (#1964)
* Add new `get_taxonomy_term` global function

* Update per @Keats feedback to make `page_count` available all the time.
2023-02-16 20:49:03 +01:00
Andrew Browne
7b562fcd2c Add slugify.paths_keep_dates option. Update docs.
Manual testing:

Existing test_site/config.toml

http://127.0.0.1:1111/posts/a-post-with-dates

====

--- a/test_site/config.toml
+++ b/test_site/config.toml
@@ -18,6 +18,7 @@ extra_syntaxes_and_themes = ["syntaxes", "highlight_themes"]

 [slugify]
 paths = "on"
+paths_keep_dates = true
 taxonomies = "on"
 anchors = "on"

http://127.0.0.1:1111/posts/2016-10-08-a-post-with-dates

====

--- a/test_site/config.toml
+++ b/test_site/config.toml
@@ -17,7 +17,8 @@ highlight_theme = "custom_gruvbox"
 extra_syntaxes_and_themes = ["syntaxes", "highlight_themes"]

 [slugify]
-paths = "on"
+paths = "off"
+paths_keep_dates = true
 taxonomies = "on"
 anchors = "on"

http://127.0.0.1:1111/posts/2016-10-08_a-post-with-dates

====

--- a/test_site/config.toml
+++ b/test_site/config.toml
@@ -17,7 +17,8 @@ highlight_theme = "custom_gruvbox"
 extra_syntaxes_and_themes = ["syntaxes", "highlight_themes"]

 [slugify]
-paths = "on"
+paths = "safe"
+paths_keep_dates = true
 taxonomies = "on"
 anchors = "on"

http://127.0.0.1:1111/posts/2016-10-08_a-post-with-dates
2023-02-16 20:49:03 +01:00
Vinicius Akira
715bd0db60
Update zola-deploy-action version on docs (#2098)
Old version was not able to fetch theme submodules: https://github.com/shalzz/zola-deploy-action/issues/50

It was fixed in the following PR: https://github.com/shalzz/zola-deploy-action/pull/52

This commit changes the docs to match the newest  `zola-deploy-action`  version, without the problem above.
2023-02-13 13:50:27 +01:00
Vincent Prouillet
f27ea8c029 Fix typo 2023-02-11 16:12:39 +01:00
Marcin Puc
3e5c19fffa
document installing via github actions (#2097) 2023-02-11 15:28:49 +01:00
David Reed
ae79a605c6
Document the render field on taxonomies (#2094) 2023-02-10 09:31:49 +01:00
Koen Bolhuis
9ea33f0dbd
Fix erroring suggestion in docs (#2087)
The docs suggest `reverse` after `group_by`, but that causes an error.
2023-02-08 22:31:18 +01:00
Scott Bronson
3af1815ea3
Best way to install Zola on Fedora now is COPR (#2070) 2023-01-28 22:44:46 +01:00
Vincent Prouillet
d899f3be6a
Update themes gallery (#2047)
Co-authored-by: GitHub Action <action@github.com>
2023-01-08 22:01:11 +01:00
Rishi Raj Jain
2b7875ff8c
docs: rebrand Layer0 to Edgio (#2068) 2023-01-08 21:30:29 +01:00
Kian-Meng Ang
1353585cbb
Fix typos (#2056)
Found via `codespell docs -S docs/content/themes -L
crate,mouvement,edn,tese,doas`
2023-01-02 16:16:33 +01:00
Nikita Ronja
8bbf37791f
documentation: Add pkgsrc. (#1812) 2022-12-13 10:59:54 +01:00
Hugo Trentesaux
1dc768284c
Update creating-a-theme.md (#2045)
remove duplicate doc
2022-12-03 21:15:40 +01:00
Vincent Prouillet
1e2da2fc25
Update themes gallery (#2038)
Co-authored-by: GitHub Action <action@github.com>
2022-11-30 15:36:35 +01:00
Alexander Borsuk
7ff5277925
Fixed default_language typo (#2040) 2022-11-28 10:20:41 +01:00
magikstm
6f29740c18
Update Shortcodes doc to add details on Macros for templates (#2035) 2022-11-25 12:01:33 +01:00
Vincent Prouillet
4eb3ec82d7
Update themes gallery (#2014)
Co-authored-by: GitHub Action <action@github.com>
2022-11-14 21:22:17 +01:00
Berin Aniesh
c9786020e4
update version of zola-deploy-action (#2012) 2022-11-02 22:05:11 +01:00
YesSeri
53cf920291
Quotation mark bug fix (#2005)
Changed double quotation mark " to single quotation ', otherwise the code doesn't work.
2022-10-30 21:43:05 +01:00
Vincent Prouillet
eba1913cdf
Update themes gallery (#1999)
Co-authored-by: GitHub Action <action@github.com>
2022-10-11 19:32:06 +02:00
Edward Maxwell-Lyte
ad6c834123
docs: github action version updates (#1977)
* docs: github action version updates

* Uses latest version of the action
* Updated requirement for token to be set
  (138a3568d1/entrypoint.sh (L44)
  will exit out without it)
* Reduced TOKEN scope and added scope to URL. Aligns with action docs

* docs: revert commentary on token requirement

* docs: add note about passing in automatic token
2022-08-30 10:28:49 +02:00