Commit graph

444 commits

Author SHA1 Message Date
Youri Seichter ba0c384602
Clarify where to define the theme in the .toml file (#1390)
It was not clear that the user has to place it in the top level of the
file. I had an issue with that.
2021-03-06 21:12:21 +01:00
Vincent Prouillet 2a46e07e74 Add path to TaxonomyTerm
Closes #1336
2021-02-22 21:27:52 +01:00
Yngve Høiseth d29693066e
Document conditional TOC rendering (#1376)
* Document conditional TOC rendering

* Simplify demonstration of conditional rendering
2021-02-22 21:05:45 +01:00
throwaway1037 8630c790b8
Update outdated link (#1375)
This change is less confusing to readers as it does not redirect.
2021-02-22 18:11:32 +01:00
throwaway1037 c26b94ab8a
Remove stray word (#1368) 2021-02-21 08:14:30 +01:00
apiraino 5ce082dfad
Add Sourcehut Pages as deployment platform (#1365) 2021-02-20 17:26:46 +01:00
Skyper d3ab3936de
[WIP] Add support for base64-encoded hash values to 'get_file_hash' (#1339)
* Add support for base64-encoded hash values

The global template function 'get_file_hash' can now return a
base64-encoded hash value when its 'base64' parameter is set to true.

See discussion in #519.

* Fix integrity attribute's value in test site

SRI hash values must be base64-encoded.

* Update documentation about 'get_file_hash'

* Fix 'can_get_hash_for_static_files' unit test
2021-02-20 13:31:37 +01:00
Hanno Braun 6d6df45f23
Make shortcodes work in markdown filter (#1358)
* Move `load_tera` to `templates`

I don't know if this is a good place for it, conceptually. I'm moving it
there because I need to use it from `templates`, and `templates` can't
depend on `site`, because there's already a dependency in the opposite
direction.

* Load templates in `markdown` filter

This enables the `markdown` filter to handle shortcodes, as long as
those shortcodes don't access any context variables.

Addresses #1350

* Update documentation of `markdown` filter

* Only load templates for `markdown` filter once

* Clarify `markdown` filter documentation

This is a lightly edited version of what @southerntofu suggested.
2021-02-19 20:51:08 +01:00
Philip Kristoffersen 8eac5a5994
WebP support in resize_image (#1360)
* Removing unused webpl

* Adding clarification comment

* Updating documentation

* Adding webp
2021-02-18 22:30:10 +01:00
Jeremy bf05a54a2e
Add live reload tip for serving site with docker (#1352) 2021-02-13 20:06:59 +01:00
Benjamin Kane def95886fb
Add final directory structure to overview (#1348)
For https://github.com/getzola/zola/issues/1341
2021-02-12 14:36:01 +01:00
Chiu-Hsiang Hsu 3cb61c3bcd
Support embed YouTube playlist (#1342) 2021-02-07 17:13:03 +01:00
William Desportes 49b6087d21
Document Docker Hub (#1337) 2021-02-03 14:59:45 +01:00
William Desportes afd5da4f64
Improve documentation (#1335)
* Fix "overriden" to "overridden" typo

* Add my website to the EXAMPLES

* HTTPS migration for some links

* Fix #1295 - Document alpine linux version

Fixes: #1295

* Update Zola version on Travis CI example

* Documentation improvements and typo fixes

* Update more example versions and remove the useless variable on the GitLab CI example

* Fix all broken links and theme links
2021-02-03 13:13:49 +01:00
Vincent Prouillet 3b210d648c Use zola 0.13 for docs 2021-02-02 20:57:37 +01:00
southerntofu 15e0ae6699
load_data() template function takes a required boolean flag (closes #1209) (#1306)
* load_data() template function takes a `required` boolean flag

* Update tests for load_data()

* Add test to make sure invalid data always fails in load_data

* Better documentation, fixing a few typos

Co-authored-by: southerntofu <southerntofu@thunix.net>
2021-02-02 20:19:44 +01:00
Yngve Høiseth c531f8cbfc
Document how to get translation for active language (#1329)
This was not obvious for me, so I assume some others might miss it.
2021-01-31 21:05:17 +01:00
David James 92b5b4b3a5
Add sort_by title (#1315)
* Add sort_by=title

* Remove old comment.

* Remove println! debugging

* Minor: text spacing

* Use lexical_sort crate for sort_by title

Co-authored-by: David James <davidcjames@gmail.com>
2021-01-20 15:35:25 +01:00
southerntofu 6950759eda
Internal links are supported in markdown filter (#1318)
* Internal links are resolved in tera markdown filter (close #1296 #1316)

* Add a test for internal links in markdown filter

Co-authored-by: southerntofu <southerntofu@thunix.net>
2021-01-20 09:24:55 +01:00
Vincent Prouillet 63e1759713 Add pagination example to docs
Closes #1237
2021-01-09 10:26:32 +01:00
Matt Riggott 3b074c185c
Include "markdown" in list of config.toml sections (#1290) 2021-01-07 10:49:17 +01:00
Vincent Prouillet 74bf676ced Update MSRV 2021-01-05 22:15:09 +01:00
Vincent Prouillet 7540ecd58e Prefer custom syntax before built-in ones 2020-12-29 10:36:40 +01:00
Vincent Prouillet 2362cf2415 Move syntaxes around to make packing a two step process
Closes #1268
2020-12-28 17:39:54 +01:00
jfranklin9000 35e9f2bbc0
Remove blog page content enclosing paragraph tags in Overview (#1267) 2020-12-24 10:03:30 +01:00
Vincent Prouillet fc8b4066f2 Update syntaxes + replace js lang in rendering
Closes #1241, #1211
2020-12-15 10:42:35 +01:00
Vincent Prouillet 2d71a79bbe Fix site 2020-12-14 20:58:59 +01:00
Nathanael Lane a210abc5a3 Add shortcode 'invocation' variable to allow a shortcode to track how… (#1236)
* add shortcode 'invocation' variable to allow a shortcode to track how many times it has been invoked in a given Markdown file

* use closure (implicit struct) instead of explicit struct for invocation tracking

* update variable name to "nth"
2020-12-14 20:43:32 +01:00
Rostislav 679af5b8c8 add Allow: / to default robots.txt template (#1258)
Also update the documentation about it.
2020-12-14 20:43:32 +01:00
Kevin Ottens 4754cb5792 Yaml frontmatter (#990)
* Accept dates presented as strings

Still, if we find a string we involve the TOML parser to make sure the
content of said string would be a correct TOML date. In a pure TOML
world this isn't exactly relevant, but this will come in handy when
using a YAML deserializer.

Signed-off-by: Kevin Ottens <ervin@ipsquad.net>

* Add serde_yaml and test-case dependencies

This will be necessary for the YAML frontmatter handling and
corresponding unit tests.

Signed-off-by: Kevin Ottens <ervin@ipsquad.net>

* Add YAML front matter handling

Signed-off-by: Kevin Ottens <ervin@ipsquad.net>

* Switch RawFrontMatter enum to wrap &str instead of String

Signed-off-by: Kevin Ottens <ervin@ipsquad.net>

* Update the documentation to mention YAML frontmatter

This is just a light update on purpose. There would be no point in
pushing YAML too much, this is mainly here to help people with a backlog
of posts to transition.

Signed-off-by: Kevin Ottens <ervin@ipsquad.net>
2020-12-14 20:43:31 +01:00
Vincent Prouillet 59d3d8a3da Enable smart punctuation
Closes #740
2020-12-14 20:43:31 +01:00
Vincent Prouillet 5d2c25b8c5 Little docs tweak 2020-12-14 20:43:31 +01:00
Vincent Prouillet 2c681f3439 Add some external link markdown tweaking options
Closes #681, #695
2020-12-14 20:43:31 +01:00
Vincent Prouillet 94634fe87d Move markdown config to its own section in config.toml 2020-12-14 20:43:31 +01:00
Renato Caldas 2673466998 Add bibtex support to load_data() (#1190)
* Add support for loading Bibtex data.

* Add load_data() documentation for the bibtex format

* Force bibtex tags to be lower case.

Bibtex tags are case-insensitive, and this works around tera's case-sensitiveness.

* Improve the load_data() documentation for the bibtex format
2020-12-14 20:43:31 +01:00
Basix 944cba030e Allow to specify default language in filenames (#1233)
* Use default language if code is same as default

* Add test for specifying default locale

* Update docs to mention default languages
2020-12-14 20:43:31 +01:00
Sam Vente 2154201fc6 Expand taxonomy documentation with movie example (#1219)
* Expand taxonomy documentation with movie example

* Fix typos

* Remove yaml syntax highlighting

Co-authored-by: Vincent Prouillet <balthek@gmail.com>
2020-12-14 20:43:31 +01:00
Vladislav Nikonov b1091bbb45 Implemented emoji aliases support in markdown files (#1194)
* Implemented emoji aliases support in markdown files

* Added emoji aliases rendering unit tests

* Added bench for emoji
2020-12-14 20:43:31 +01:00
Sam Vente c40fb91ba8 Make sections draftable (#1218)
* make sections draftable

* add documentation paragraph about drafting sections
2020-12-14 20:43:31 +01:00
areille 6a31ccff99 Enable html minification (#1208)
* Next version

* Remove lines forcing minify_html to false

* Update documentation about minify_html

* Update changelog

Co-authored-by: Vincent Prouillet <balthek@gmail.com>
2020-12-14 20:42:55 +01:00
Takayuki Nakata 575c38f9c8 Support output_dir in config.toml 2020-12-14 20:42:55 +01:00
Fredrik 37e24c27f1
Get zola from alpine community repository (#1251)
Zola is not available in the `testing` repository, getting it from `community` instead
2020-12-06 21:43:23 +01:00
Kiyan Mair f5a200e64c
Fix RSS block example in documentation (#1210)
This commit fixes a bug in the documentation for the feeds page which
shows how to use the RSS block to enable feed autodiscovery.

The bug used an em space character instead of a space in one part of the
code snippet. If a user were to copy the code snippet into their code as
directed, the Zola build would fail with a parse error. The em space
appears identical to a regular space in monospaced fonts, making the
error seem mysterious or incorrect.

I believe the em space was used in order to prevent the shortcode from
rendering, as the code snippet is just meant to show what the shortcode
looks like. However, it is possible to escape the shortcode so that it
renders correctly without causing confusion for the user who expects to
be able to copy and paste it.

This commit replaces the em space in both code snippets with regular
spaces and escapes the shortcodes.
2020-10-21 13:00:16 +02:00
Vincent Prouillet 94c016521c Fix zola serve 2020-09-28 09:36:16 +02:00
Tim Visée c27f749a86 Fix #1165, improve situation for compile_sass errors (#1166)
* Update compile_sass docs, this is just for sass files in site root

* Improve file watch error, question whether the target exists
2020-09-22 09:46:22 +02:00
Rafael Epplée d04a52d096
Make gitlab CI example script faster (#1171)
By using alpine, the time to pull and start the container decreases.
By using the official alpine zola package, the script gets simpler.
Also, this updates the zola version to the latest release.
2020-09-18 15:35:38 +02:00
Maximilian Schoenenberg 9f367ae7e7
Added description for github actions (#1163)
* Added description for github actions

* Added specific version and removed outdated sentence regarding branch naming
2020-09-14 10:36:56 +02:00
Spencer Burris 924100f011 Add Void Linux installation instructions 2020-09-05 10:28:44 -07:00
Vincent Prouillet 2d1c954322
Merge pull request #1038 from getzola/next
Next version
2020-09-04 23:42:30 +02:00
Spencer Burris 428b5942c7
Fix documentation typos (#1157) 2020-09-04 22:53:31 +02:00
Vincent Prouillet ba240cd27f Change min Rust version in docs 2020-09-03 21:25:42 +02:00
Vincent Prouillet e0068ef116 Remove mention from changelog 2020-09-01 21:23:29 +02:00
Vincent Prouillet 6c2300f916 Disable minify_html for now 2020-09-01 21:07:18 +02:00
Sam Vente c143d95c4e
Reverse pagination (#1147)
* mention code block output change

* Update snap

* Update themes gallery (#1082)

Co-authored-by: GitHub Action <action@github.com>

* Deployment guide for Vercel

* Change wording a bit

* Update themes gallery (#1122)

Co-authored-by: GitHub Action <action@github.com>

* Add feed autodiscovery documentation (#1123)

* Add feed autodiscovery documentation

* Fix link in template

* Docs/configuration update (#1126)

* Update configuration documentation

- Attempt to split the configuration file into sections to make it more readable and
  avoid configuration mistakes (#1056).
- Move translation instructions to the right part.
- Add a bit more explanations to the extra section.

* Take into account @Keats feedbacks

* Remove short notice about translation usage

- A i18n page should be created to better explain it.

* add fix for (#1135) Taxonomies with identical slugs now get merged (#1136)

* add test and implementation for reverse pagination

* incorporate review changes

Co-authored-by: Michael Plotke <bdjnks@gmail.com>
Co-authored-by: Vincent Prouillet <balthek@gmail.com>
Co-authored-by: GitHub Action <action@github.com>
Co-authored-by: Samyak Bakliwal <w3bcode@gmail.com>
Co-authored-by: René Ribaud <uggla@free.fr>
2020-09-01 21:00:21 +02:00
Vincent Prouillet 4f5fd63281 Update deps + pinned 2020-08-28 19:49:19 +02:00
areille 0df3631b3d
Add minify support (#1146)
* Doc add a missing arg to `get_taxonomy_url` (#1139)

This feature is already exist, but not in the doc yet

Related #766

* Add minify support

* Add documentation

* Code review

* Fix error in documentation

* Update minify-html to 0.3.6

* Move minify into write_content function

* Fix multiple calls to minify()

* Add test for minified output

* Fix breaking test

Co-authored-by: Ken <2770219+ken0x0a@users.noreply.github.com>
2020-08-28 19:39:19 +02:00
Yaroslav d571dea8c3
Per section/subsection feeds (#1128)
* Per section/subsection feeds

* Added `generate_feed` variable to section front matter.
* Generate atom/rss feeds for sections/subsections that have the
`generate_feed` variable set to true (false by default); this works
independent of the `generate_feed` variable in the root `config.toml`
file, however, the name (and template) of the feed file for each section
is the same as `feed_filename` in `config.toml`, just located in the
root of each section.
* Slightly edited `atom.xml` and `rss.xml` so that they include the
section title (if any), and the url of a section, if it's a section
feed.

* Section feeds: tests

* Changed a couple of sections' front matter in order to generate feeds
for them for the test.
* Changed the can_build_feed test in site package to can_build_feeds and
included some assertions to make sure that section feeds are generated
when requested.

* Section feeds: documentation

* Added information about the section front matter variable
`generate_feed` in the section content page.
* Added information about section feeds in the feeds template page.

* Section feeds fix: use section.path for feed path
2020-08-27 20:21:37 +02:00
Sam Vente 6e16dfdc29
A Fix for the permalinks in #1136 (#1142)
* add fix for (#1135) Taxonomies with identical slugs now get merged (#1136)

* update templates so they propperly render taxonomy names

* squash! add fix for (#1135) Taxonomies with identical slugs now get merged (#1136)

reimplement taxonomy deduping

* revert unwanted changes to templates

* add tests for unic in permalinks

* add tests for unic in permalinks
2020-08-26 19:36:02 +02:00
Ken d198ad64db
Doc add a missing arg to get_taxonomy_url (#1139)
This feature is already exist, but not in the doc yet

Related #766
2020-08-18 13:06:49 +02:00
Sam Vente 05646ab573
add fix for (#1135) Taxonomies with identical slugs now get merged (#1136) 2020-08-18 12:59:33 +02:00
Vincent Prouillet 7666043b16
Merge branch 'master' into next 2020-08-17 21:39:29 +02:00
Vincent Prouillet 278cc82fc7
Change zola serve to load HTML from memory instead of disk (#1114)
* Change zola serve to load HTML from memory instead of disk

* Be smart about assets copying

* Be a tiny bit smarter on template changes

* Add zola serve --fast
2020-08-16 18:39:04 +02:00
René Ribaud 261a2eee01
Docs/configuration update (#1126)
* Update configuration documentation

- Attempt to split the configuration file into sections to make it more readable and
  avoid configuration mistakes (#1056).
- Move translation instructions to the right part.
- Add a bit more explanations to the extra section.

* Take into account @Keats feedbacks

* Remove short notice about translation usage

- A i18n page should be created to better explain it.
2020-08-16 18:25:52 +02:00
迷渡 6379723248
fix link (#1127) 2020-08-13 11:10:02 +02:00
René Ribaud 274a5be6f5
Fix title level of check command (#1125) 2020-08-12 22:46:07 +02:00
René Ribaud 282a755fb1
Add feed autodiscovery documentation (#1123)
* Add feed autodiscovery documentation

* Fix link in template
2020-08-12 09:20:16 +02:00
liushuyu 6af7959fce
Making Chinese and Japanese search indexing optional... (#1115)
* This can shave ~80 MB off the binary size while allowing users
  speaking these two languages to easily switch them back on
2020-08-07 17:03:51 +02:00
Jakub Neander 39eed4fdee
add OneHalf Light/Dark theme (#1116) 2020-08-03 20:08:17 +02:00
Peter H. Ezetta b359cca4fe
adding OpenBSD installation instructions (#1109) 2020-07-30 11:03:01 +02:00
yanghuidong b9296f7985
Make current_path always start with a slash (#1101)
* Make {section, page}.path always start with a slash

Change tests accordingly

* Fix missing leading/trailing slash in current_path of Taxonomy ("tags") and TaxonomyItem ("some-tag")

* Make {Paginator, Pager}.path always start with a slash

Fix Paginator.path missing trailing slash in from_taxonomy()

Change tests accordingly

* Update documentation regarding current_path now always starting with a slash

* Fix asymptomatic inverted logic in filter() for {section, page}.assets

* Add to 3 integration tests several checks for current_path in different templates

* Add a check for current_path in a paginated index section, "/page/2/"

This requires adding two dummy pages in the content root.

* Fix false passing of test on paginator.last due to URL prefix matching

A string formatting such as {name: value} can help prevent this.
2020-07-29 20:44:09 +02:00
eaon 28523ac9ad
Allow emitting newlines and whitespace in shortcodes and introduce markdown shortcodes (#1085)
* Replace hack for newline support in shortcodes with new hack

* Be a bit more space efficient/accurate with naming

* Boil newline/whitespace shortcode test down to the essentials

* Make sure the new \n and \s chars in old tests are properly represented

* Support markdown templates and shortcodes

* Refactoring .md/.html shortcode behaviour

* Add test for markdown shortcodes

* Add an html output test for markdown based shortcodes

* Add documentation for Markdown based shortcodes
2020-07-29 20:20:43 +02:00
Vincent Prouillet 97e772868d Merge branch 'hmble-patch-1' 2020-07-22 18:42:56 +02:00
Vincent Prouillet d242b6bd5f Change wording a bit 2020-07-22 18:41:39 +02:00
René Ribaud 2514ad9981
Add warning to not put taxonomies key in [extra] (#1095) 2020-07-22 10:38:15 +02:00
Vincent Prouillet ffd87dc531 Update syntect syntaxes 2020-07-19 16:40:24 +02:00
Samyak Bakliwal b3d9fd915c
Deployment guide for Vercel 2020-07-19 17:26:32 +05:30
Sven-Hendrik Haase 26a5a368d3
Zola is now available in the official Arch repos (#1089) 2020-07-19 10:51:03 +02:00
Vincent Prouillet fb994c71d7 Make search index configurable
Closes #961
2020-06-29 20:02:27 +02:00
Vincent Prouillet c6a1c8be5c Clearer page sorting comment 2020-06-18 23:21:35 +02:00
Vincent Prouillet cb198ab597 Document get_taxonomy_url
Closes #956
2020-06-18 22:50:27 +02:00
southerntofu e47deccf43
Make themes more flexible (#1004)
* Site templates can replace theme templates

* Integrate test case within test_site/

* Full backwards-compatibility with testcase in test_site

* Refine test case

* Call parent's block in child template for test case

* Check both templates are applied

* Follow testing advice

* Test for 'include' in themes and shortcodes

* Documentation for themes and how to extend them

Co-authored-by: Vincent Prouillet <balthek@gmail.com>
2020-06-18 22:31:03 +02:00
Per Lundberg 530f918955
Add --force/-f flag to init, for creation in non-empty dir (#1065) 2020-06-18 21:15:46 +02:00
Matthias 5e31a32166
Add support for SVG files to get_image_metadata (Fixes #769) (#1063)
* Add support for SVG files to `get_image_metadata`

* Add support for SVG files to `get_image_metadata`

* Update documentation after adding SVG support
2020-06-18 11:36:11 +02:00
2mol 47bd7c9e82
fix material-light theme link (#1066) 2020-06-17 11:03:06 +02:00
bemyak 8d4056ab30
Add GLSL and GDScrip syntax highlighting (#1060) 2020-06-12 12:19:50 +02:00
Hannu Hartikainen 6708f7637c
Implement get_file_hash (#1044)
* Fix get_url(cachebust=true)

The previous implementation looked for static files in the wrong place.
Look in static_path, output_path and content_path. If file can't be
found in any of them, print a warning to stderr and fall back to using
a timestamp.

Add a test to ensure it also works in practice, not just in theory.

* Implement get_file_hash
2020-06-09 22:38:29 +02:00
Vincent Prouillet a3a5b9ea06
Merge pull request #976 from getzola/next
0.11.0
2020-05-25 18:14:42 +02:00
Vincent Prouillet 3a292d294a Prepare for release 2020-05-25 10:26:30 +02:00
Hannu Hartikainen 36ec33f042
Change get_url(cachebust=true) to use a hash (#1032)
Cache-busting was previously done with a compile-time timestamp. Change
to the SHA-256 hash of the file to avoid refreshing unchanged files.

The implementation could be used to add a new global fn (say,
get_file_hash) for subresource integrity use, but that's for another
commit.

Fixes #519.

Co-authored-by: Vincent Prouillet <balthek@gmail.com>
2020-05-23 11:46:50 +02:00
Hannu Hartikainen a7657f30ab
Use {{ page.permalink | safe }} in tutorial (#1024)
The `&#x2F;` urls are confusing to newcomers (at least myself). Use the best practice in the tutorial (see issue #129).
2020-05-13 08:40:06 +02:00
Vincent Prouillet fbf431d612 Update syntect, using rust-onig with bindgen temporarily 2020-05-12 20:07:02 +02:00
Vincent Prouillet bc496e6101 Update syntaxes and syntect 2020-04-29 22:35:28 +02:00
southerntofu e3dc8bbab5
Access heading level in anchor-link.html (#1008)
* Add lvl variable in anchor-link context

* Add docs about lvl in anchor-link.html

* Rename lvl => level
2020-04-29 19:40:25 +02:00
Adrian Sieber 79b2338bd3
Fix path of generated page (#1011) 2020-04-27 09:35:53 +02:00
Clément Joly 6b91328e81
Typos (#1010) 2020-04-26 20:35:59 +02:00
Gelez 7b3279befd
Theme docs: actually edit the config (#996)
I hope it is just not me that misunderstood the sentence above, but I think it should be `true` and not `false`.
2020-04-22 09:48:08 +02:00
Vincent Prouillet c04e6ebaf5 Some tweaks 2020-04-21 19:28:58 +02:00
Chris Morgan 4653e68715 Add lang, taxonomy and term to feed template
Also a FIXME on the rebuilding part, because it’s presently very wrong.
2020-04-14 17:29:51 +05:30
Chris Morgan eb7751955a WIP: add an 'updated' field to pages
Also change a few other things to use it, as noted in CHANGELOG.md.

TODO:

- Write a couple of tests: updated field, last_updated template variable

One slight open questions: should `updated` default to the value of
`date` rather than to None? Then pages with `date` could safely assume
`updated`.
2020-04-14 17:29:46 +05:30
Chris Morgan 048949ea31 Rename last_build_date to latest_date
The variable name matched the RSS tag it ended up in, but was misleading
about what it actually was—because if you actually want “last build
date”, you should use `now()`. (Due to the potential for edits, I think
that either there should be an official `updated` field on pages, or
that these templates should use `now()`.)
2020-04-14 17:27:08 +05:30