Commit graph

686 commits

Author SHA1 Message Date
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
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
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
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
Vincent Prouillet
7f4060b82a
Update themes gallery (#1971)
Co-authored-by: GitHub Action <action@github.com>
2022-08-22 22:30:31 +02:00
Radovan Bast
f61e1ba9a2 parse also *.yml file suffix as YAML; closes #1958 (#1959)
previously only files with *.yaml suffix were recognized as YAML
2022-08-14 16:08:48 +02:00
Newbyte
6f0697d438 Update Alpine Linux installation instructions (#1953) 2022-08-14 16:08:48 +02:00
Erazem Kokot
a0333e71d3
Update Sourcehut deployment instructions (#1948)
This commit updates the example code for deploying Zola on Sourcehut and
also updates the wording of the tutorial a bit.
2022-08-01 12:42:51 +02:00
Vincent Prouillet
15a523b624 Add docs for backlinks 2022-07-25 14:14:12 +02:00
Vincent Prouillet
39bfbcd019
Merge pull request #1741 from getzola/next
Next version
2022-07-16 23:25:10 +02:00
Vincent Prouillet
7208b86d77
Insert anchor as full heading (#1916)
* Add insert_anchor = "heading"

* Update CHANGELOG.md

Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
2022-07-10 15:02:07 +02:00
mscherer
9669db0dcd
Fix misspelling in documentation (#1914) 2022-07-04 09:42:43 +02:00
Ayush
c2bdfb9af7
Add flatpak installation to docs (#1906)
Signed-off-by: Ayush Singh <ayushsingh1325@gmail.com>
2022-06-21 17:17:23 +02:00
Vincent Prouillet
faf306ec1b
Update themes gallery (#1899)
Co-authored-by: GitHub Action <action@github.com>
2022-06-18 23:12:04 +02:00
nyanpasu64
72243d9eeb
Fix incorrect documentation for syntax directory (#1901)
Currently the Configuration docs says to load syntax files into
config.toml [markdown] extra_syntaxes. However, ever since commit
23064f57c8 (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.
2022-06-16 14:37:49 +02:00
Vincent Prouillet
5873e0319c Add title_bytes sorting method 2022-06-13 23:37:39 +02:00
Vincent Prouillet
4cb91dab0b Remove simplify theme
Closes #1863
2022-06-13 09:50:58 +02:00
bemyak
d4b5c4fdc4
Make robots.txt compliant with RFC (#1895)
The [RFC](http://www.robotstxt.org/orig.html) mentions only `Disallow`
directive, so it must appear in the file.

`Allow` is an ad hoc agreement between search engines that no all of
them follow.
2022-06-12 21:41:38 +02:00
Vincent Prouillet
72461a1fc9
Update themes gallery (#1894)
Co-authored-by: GitHub Action <action@github.com>
2022-06-10 21:57:32 +02:00
Vincent Prouillet
c70aaf781e
Merge branch 'master' into next 2022-06-10 21:26:48 +02:00
Vincent Prouillet
42bcbf63cc Mention PAT for GH deploys
Closes #1785
2022-06-10 21:23:11 +02:00
Vincent Prouillet
85a16d1d4b Fix old docker image reference
Closes #1861
2022-06-10 21:16:38 +02:00
Vincent Prouillet
3c540198b0 Mention CSS files in static assets overview
Closes #1892
2022-06-10 20:44:09 +02:00
Vincent Prouillet
294505f4bc
Update themes gallery (#1887)
Co-authored-by: GitHub Action <action@github.com>
2022-06-06 10:46:29 +02:00
Jt Miclat
aff5bff0a6
Update docker image name in docker installation (#1889) 2022-06-06 10:46:00 +02:00
Vincent Prouillet
b90492f641
Update themes gallery (#1860)
Co-authored-by: GitHub Action <action@github.com>
2022-05-16 10:42:25 +02:00
Michael Clayton
6240ed5469
add link_checker settings for external_level and internal_level (#1848)
* add external_level and internal_level

* remove unnecessary debug derive on LinkDef

* clarify doc comment about link check levels

* simplify link checker logging

* add missing warn prefix

* simplify link level logging, remove "Level" from linklevel variants

* remove link level config from test site

* switch back to using bail! from get_link_domain

* move console's deps to libs

* remove unnecessary reference

* calling console::error/warn directly

* emit one error, or one warning, per link checker run

* various link checker level changes

* add docs about link checker levels

* remove accidentally committed test site

* remove completed TODO
2022-05-11 21:54:34 +02:00
Colin Dean
f7f5545bdc
Enables setting base-url to / for relative URLs in serve mode (#1853)
Having to change the base URL to whatever ngrok URL was provisioned for
me was frustrating. This patch enables setting it to `/`, which will
then make the `get_url()` function simply return `/`.
2022-05-10 22:04:40 +02:00
Vincent Prouillet
beb93f2b0a Expose backlinks 2022-05-08 14:10:29 +02:00