Commit graph

196 commits

Author SHA1 Message Date
Avinash Sonawane
14b1a3570a
Docs: Add highlight theme green to docs (#1486) 2021-05-24 10:42:57 +02:00
Avinash Sonawane
60386292a8
Docs: Move build_search_index to root level in config.toml (#1479) 2021-05-23 17:15:48 +02:00
Avinash Sonawane
8ee6df030f
Docs: Mention that the output directory will be deleted before build (#1472)
and serve
2021-05-23 13:53:25 +02:00
Avinash Sonawane
22fcae457a
Docs: Add second.md filename to directory structure overview (#1469) 2021-05-21 22:00:30 +02:00
Avinash Sonawane
0596b9944c
Docs: Remove --watch-only flag (#1468) 2021-05-21 21:58:13 +02:00
Vincent Prouillet
5df6e034c4 Update MSRV 2021-05-09 23:03:19 +02:00
Chanakya
3a5ae0f073
Update configuration.md (#1450) 2021-05-08 20:44:31 +02:00
Vincent Prouillet
10c1739c62 Update pinned MSRV 2021-05-05 21:36:56 +02:00
Vincent Prouillet
84fb2f30f3 Mention WSL2 filesystem
From #1440
2021-05-05 19:35:59 +02:00
Martin Simon
a0b92be9f6
doc(installation): add Debian package (#1432) 2021-04-26 09:27:23 +02:00
Stanislas
6e2595a191
doc(syntax-highlighting): fix available values (#1427) 2021-04-07 21:17:02 +02:00
Tiago Seabra
534174ae78
feat: add base16-atelierdune-light highlight theme (#1406)
* feat: add base16-aterlierdune-light highlight theme

* docs: add base16-atelierdune-light theme to CHANGELOG
2021-03-14 09:49:29 +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
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
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
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
jfranklin9000
35e9f2bbc0
Remove blog page content enclosing paragraph tags in Overview (#1267) 2020-12-24 10:03:30 +01:00
Vincent Prouillet
59d3d8a3da Enable smart punctuation
Closes #740
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
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
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
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
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
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
René Ribaud
274a5be6f5
Fix title level of check command (#1125) 2020-08-12 22:46:07 +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
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
Per Lundberg
530f918955
Add --force/-f flag to init, for creation in non-empty dir (#1065) 2020-06-18 21:15:46 +02:00
2mol
47bd7c9e82
fix material-light theme link (#1066) 2020-06-17 11:03:06 +02:00
Vincent Prouillet
a3a5b9ea06
Merge pull request #976 from getzola/next
0.11.0
2020-05-25 18:14:42 +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
bc496e6101 Update syntaxes and syntect 2020-04-29 22:35:28 +02:00
Chris Morgan
e25915b231 Support and default to generating Atom feeds
This includes several breaking changes, but they’re easy to adjust for.

Atom 1.0 is superior to RSS 2.0 in a number of ways, both technical and
legal, though information from the last decade is hard to find.
http://www.intertwingly.net/wiki/pie/Rss20AndAtom10Compared
has some info which is probably still mostly correct.

How do RSS and Atom compare in terms of implementation support? The
impression I get is that proper Atom support in normal content websites
has been universal for over twelve years, but that support in podcasts
was not quite so good, but getting there, over twelve years ago. I have
no more recent facts or figures; no one talks about this stuff these
days. I remember investigating this stuff back in 2011–2013 and coming
to the same conclusion. At that time, I went with Atom on websites and
RSS in podcasts. Now I’d just go full Atom and hang any podcast tools
that don’t support Atom, because Atom’s semantics truly are much better.

In light of all this, I make the bold recommendation to default to Atom.

Nonetheless, for compatibility for existing users, and for those that
have Opinions, I’ve retained the RSS template, so that you can escape
the breaking change easily.

I personally prefer to give feeds a basename that doesn’t mention “Atom”
or “RSS”, e.g. “feed.xml”. I’ll be doing that myself, as I’ll be using
my own template with more Atom features anyway, like author information,
taxonomies and making the title field HTML.

Some notes about the Atom feed template:

- I went with atom.xml rather than something like feed.atom (the .atom
  file format being registered for this purpose by RFC4287) due to lack
  of confidence that it’ll be served with the right MIME type. .xml is a
  safer default.

- It might be nice to get Zola’s version number into the <generator>
  tag. Not for any particularly good reason, y’know. Just picture it:

    <generator uri="https://www.getzola.org/" version="0.10.0">
	Zola
    </generator>

- I’d like to get taxonomies into the feed, but this requires exposing a
  little more info than is currently exposed. I think it’d require
  `TaxonomyConfig` to preferably have a new member `permalink` added
  (which should be equivalent to something like `config.base_url ~ "/" ~
  taxonomy.slug ~ "/"`), and for the feed to get all the taxonomies
  passed into it (`taxonomies: HashMap<String, TaxonomyTerm>`).
  Then, the template could be like this, inside the entry:

    {% for taxonomy, terms in page.taxonomies %}
        {% for term in terms %}
            <category scheme="{{ taxonomies[taxonomy].permalink }}"
		term="{{ term.slug }}" label="{{ term.name }}" />
	{% endfor %}
    {% endfor %}

Other remarks:

- I have added a date field `extra.updated` to my posts and include that
  in the feed; I’ve observed others with a similar field. I believe this
  should be included as an official field. I’m inclined to add author to
  at least config.toml, too, for feeds.
- We need to have a link from the docs to the source of the built-in
  templates, to help people that wish to alter it.
2020-04-14 17:27:08 +05:30
SasakiSaki
073e24659d
Add highlight for lyric (#949)
* Add highlight for lyric files

* Add highlight theme nyx-bold

* Update the documents

* Add highlight for subtitle files
2020-02-21 14:14:25 +01:00
Vincent Prouillet
ac3ced828b
Multiple slugification strategies (#929) 2020-02-05 09:13:14 +01:00
Vincent Prouillet
782cc7d686 Fix some more merge conflicts 2020-02-02 17:50:36 -08:00
ethereal
94445ae745 Add --root global argument. Fixes #899. (#932) 2020-02-02 17:48:43 -08:00
photong
5ba4d47538 Docs next (#858)
* Update installation.md

* Update cli-usage.md

* Update installation.md

* Update directory-structure.md

* Update configuration.md

* Update overview.md

* Update section.md

* Update page.md

* Update section.md

* Update configuration.md

* Update page.md

* Update section.md

* Update page.md

* Update shortcodes.md

* Update linking.md

* Update table-of-contents.md

* Update syntax-highlighting.md

* Update taxonomies.md

* Update search.md

* Update sass.md

* Update index.md

* Update multilingual.md

* Update overview.md

* Update pages-sections.md

* Update pagination.md

* Update taxonomies.md

* Update rss.md

* Update sitemap.md

* Update robots.md

* Update 404.md

* Update archive.md

* Update overview.md

* Update installing-and-using-themes.md

* Update creating-a-theme.md

* Update netlify.md

* Update github-pages.md

* Update gitlab-pages.md

* Updates.

* Skip link checking for URL with prefix in config (#846)

* Fix some doc changes

* Section extra -> SitemapEntry (#850)

* Update deps

* Remove tutorial link.

* Update overview.md

* Update page.md

* Update section.md

* Update netlify.md

* Update overview.md

* Change some wording.

* Update overview.md

Co-authored-by: Tjeu Kayim <15987676+TjeuKayim@users.noreply.github.com>
Co-authored-by: Vincent Prouillet <balthek@gmail.com>
Co-authored-by: Stan Rozenraukh <stan@stanistan.com>
2020-02-02 17:48:43 -08:00
Vincent Prouillet
ceb9bc8ed7 Optionally do not slugify paths (#875)
* maybe_slugify() only does simple sanitation if config.slugify is false

* slugify is disabled by default, turn on for backwards-compatibility

* First docs changes for optional slugification

* Remove # from slugs but not &

* Add/fix tests for utf8 slugs

* Fix test sites for i18n slugs

* fix templates tests for i18n slugs

* Rename slugify setting to slugify_paths

* Default slugify_paths

* Update documentation for slugify_paths

* quasi_slugify removes ?, /, # and newlines

* Remove forbidden NTFS chars in quasi_slugify()

* Slugification forbidden chars can be configured

* Remove trailing dot/space in quasi_slugify

* Fix NTFS path sanitation

* Revert configurable slugification charset

* Remove \r for windows newlines and \t tabulations in quasi_slugify()

* Update docs for output paths

* Replace slugify with slugify_paths

* Fix test

* Default to not slugifying

* Move slugs utils to utils crate

* Use slugify_paths for anchors as well
2020-02-02 17:48:43 -08:00
Vincent Prouillet
1a6edbcf63 Fix some doc changes 2020-02-02 17:48:42 -08:00
photong
51d4b6bd6a Simple clean up of documentation. (#849)
* Update installation.md

* Update cli-usage.md

* Update installation.md

* Update directory-structure.md

* Update configuration.md

* Update overview.md

* Update section.md

* Update page.md

* Update section.md

* Update configuration.md

* Update page.md

* Update section.md

* Update page.md

* Update shortcodes.md

* Update linking.md

* Update table-of-contents.md

* Update syntax-highlighting.md

* Update taxonomies.md

* Update search.md

* Update sass.md

* Update index.md

* Update multilingual.md

* Update overview.md

* Update pages-sections.md

* Update pagination.md

* Update taxonomies.md

* Update rss.md

* Update sitemap.md

* Update robots.md

* Update 404.md

* Update archive.md

* Update overview.md

* Update installing-and-using-themes.md

* Update creating-a-theme.md

* Update netlify.md

* Update github-pages.md

* Update gitlab-pages.md

* Update index.md

* Update page.md

* Update section.md

* Updates.
2020-02-02 17:48:42 -08:00
Tjeu Kayim
75570d041a Skip link checking for URL with prefix in config (#846) 2020-02-02 17:47:01 -08:00
Tjeu Kayim
6149fd17e1 Skip anchor checking for URL with prefix in config (#812)
* cargo fmt & clippy

* Skip anchor checking for URL with prefix in config
2020-02-02 17:45:16 -08:00
Vincent Prouillet
cb4056c0f2 Add zenburn theme
Closes #813
2020-02-02 17:44:38 -08:00
Vincent Prouillet
6856b11d6d Looks like it now requires 1.36 2020-02-02 17:44:38 -08:00
David Authier
f4b6f63d3c 📝 Add TOML translations key example (#864) 2019-11-28 19:18:52 +01:00
Bob
9db9fc8fb2 Fix the issue of generating the search index for multiple language (#794)
* fix the issue of generating the search index for multiple language

* updat docs for generating the search index for multiple language

* fix failed tests

* add tests for the search index of multiple language
2019-09-03 16:50:23 +02:00
Vincent Prouillet
b396a1bc20 Add --drafts flag + rustfmt 2019-08-24 22:23:08 +02:00
BilLOPGVkPPn8z0JGJhgiAGNo9YAqpk5ruChl0F
258aecec34 Add one-dark syntax highlight theme (#784) 2019-08-24 19:06:41 +02:00
Vincent Prouillet
f0c48b8a14 Add some more text to zola init
Closes #773
2019-08-13 20:16:09 +02:00
southerntofu
13b395b536 zola init works inside existing directories (closes #406) (#777)
* zola init works without argument (defaults to current directory)

* zola init works with existing folders (no non-hidden files permitted)

* Update zola init documentation

* [docs] Optional argument is on a separate line for clarity

* Add tests for init subcommand's respect of existing folders
2019-08-13 19:56:57 +02:00
Vincent Prouillet
7f459940e1 Allow multiple taxonomies with same name in different language
Closes #766
2019-08-10 18:54:32 +02:00
Hendrik Sollich
9f46048c0e Add Tomorrow theme (#749) 2019-07-16 17:22:02 +02:00
Jakub Turski
8a737d71fb Add an option to hard link files from static/ instead of copying. (#723)
* Add hard_link_static config option.

* Copy or hardlink file depending on an argument.

Modify the call sites for `copy_file` to account for the extra argument.

* Plug the config setting through to copy_file.

Don't apply the config option to theme's static directory.

* Update documentation.

* Backticks make no sense in this comment.

* Addressing PR comments.

* Be consistent with argument naming.
2019-07-12 22:54:18 +02:00
Tim Visée
90dad05c67 Add --open flag to serve command, to open URL in default browser (#739)
* Add --open flag to serve command, to open URL in default browser

* Mention serve --open flag in CLI documentation
2019-07-12 22:54:18 +02:00
Jakub Turski
79dfe92bbf Update cli-usage.md (#729)
* Update cli-usage.md

* clarify that it's only the links from markdown files that are being checked;
2019-07-12 22:54:18 +02:00
Tobias Kortkamp
6895ae5b10 docs: Add installation on FreeBSD (#741) 2019-07-10 21:39:30 +02:00
Igor Gnatenko
a49daa7463 docs: Add installation on Fedora (#734) 2019-06-30 18:10:21 +02:00
Vincent Prouillet
e6902264ef
Merge pull request #678 from getzola/next
0.8.0
2019-06-22 11:48:56 +02:00
Bridouz
089278faa7
Add url for base16 syntax highlighting examples 2019-06-17 10:08:05 +02:00
Vincent Prouillet
ec61a57841 Use @/ for internal links rather than ./
Close #686
2019-05-27 14:35:18 +02:00
Vincent Prouillet
cdfd63a1ad Add zola check to changelog and remove check option from config doc 2019-05-27 14:16:46 +02:00
Marcus Klaas de Vries
0d964204c3 Check command global (#683)
* Add check subcommand

* Add some brief documentation for the check subcommand

* Start working on parallel link checks

* Check all external links in Site

* Return *all* dead links in site
2019-05-27 14:05:07 +02:00
Vincent Prouillet
debe0633bc Revert "Allow default base-path command line option to be set for building and serving"
This reverts commit 1815155c1d.
2019-04-20 12:50:34 +02:00
Vincent Prouillet
78c8f9cd59 Add note about Powershell ISE
Closes #530
2019-03-25 23:17:37 +01:00
Vincent Prouillet
5d695d7ce8
Merge pull request #567 from getzola/next
v.0.6.0
2019-03-25 20:26:07 +01:00
Blake Smith
1815155c1d Allow default base-path command line option to be set for building and serving 2019-03-23 20:25:56 -05:00
Eli Flanagan
ce0f0ec935 use nix-shell to build on nixos
Fix #616. Add brief documentation for how to use it.
2019-02-19 19:23:27 -05:00
Vincent Prouillet
723729b6d1
Merge branch 'master' into next 2019-02-16 15:49:19 +01:00
Leonardo Schwarz
77aad07dc6 Revert "Update snap installation instructions"
This reverts commit 5fd7bf7e61.

Apparently it is not just no longer necessary to use classic
confinement, but actually impossible, i.e. snap emits an error that the
zola snap is not compatible with `--classic`.
2019-02-05 11:09:18 +01:00
Ryan McGrath
0bcc706a55
One more time, Dracula theme, lol 2019-01-15 14:20:47 -08:00
Vincent Prouillet
cae9223ebd Mention that serve deletes the public dir as well 2019-01-07 19:24:08 +01:00
Vincent Prouillet
0f0304d7ed Mention build rm the directory 2019-01-05 11:04:12 +01:00
Vincent Prouillet
288917b42d Pest now requires 1.31 2018-12-29 11:38:28 +01:00
Vincent Prouillet
779511ae43 Pass down lang and start docs 2018-12-28 13:24:49 +01:00
Luke Peterson
825152242d Remove redundant "From Source" documentation 2018-12-15 08:35:09 -08:00
Vincent Prouillet
5eebbc68de
Merge branch 'master' into next 2018-12-14 17:35:50 +01:00
Vincent Prouillet
f193152c85 Looks like it needs 1.30? 2018-12-14 17:35:18 +01:00
Bob "Wombat" Hogg
d8693ef1f8
Mark required Rust version as 1.29
690b3f9 updated the required version in Cargo.lock and in the CI config files, but not in the installation instructions.
2018-12-11 10:58:53 -08:00
Vincent Prouillet
fb4c562088 Removing gutenberg completely from installation instructions 2018-11-30 22:23:18 +01:00
Igor Kapkov
a6ec2b65c7
Update brew docs 2018-11-30 19:37:14 +11:00
Bob "Wombat" Hogg
5fd7bf7e61
Update snap installation instructions
If you don't install with classic confinement, you'll get permission errors trying to create sites with `zola init`.
2018-11-28 22:16:40 -07:00
Vincent Prouillet
34da6fdffd yaourt -> yay 2018-11-19 17:27:15 +01:00