Commit graph

498 commits

Author SHA1 Message Date
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
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
Chris Morgan
cc64803553 Fix documentation of TaxonomyConfig fields
It doesn’t have a field named slug.

It does have a field named lang.
2020-04-14 17:27:08 +05:30
Chris Morgan
896c30d892 Fix a broken Markdown link in the docs
Whitespace is not allowed between the `]` and `(`.
2020-04-14 17:27:08 +05:30
Chris Morgan
c2dd408df4 Fix obsolete slugify_paths documentation 2020-04-14 17:27:08 +05:30
0xC45
167b2b9974
Fix sass documentation error in example path name (#991) 2020-04-12 21:38:53 +02:00
GaaH
41bbaeb970
Add an optionnal lang parameter to get_url (#982)
* get_url takes an optionnal  parameter

* Documentation about the 'lang' parameter of 'get_url'

Co-authored-by: Gaëtan Caillaut <gaetan.caillaut@live.com>
2020-04-12 19:23:17 +02:00
Vincent Prouillet
b2eb00a374 Ensure lang is always set on default sections 2020-04-12 19:17:29 +02:00
Vincent Prouillet
fb6cbe008f Mention how to get config variables in templates 2020-04-12 18:48:00 +02:00
Vincent Prouillet
469babbd97 Update docs on markdown filter
Closes #989
2020-04-12 17:26:01 +02:00
Vincent Prouillet
56e25132a9 Update deps + fix some misleading doc 2020-04-12 17:21:04 +02:00
Vincent Prouillet
4242723e4d Update syntect dump files 2020-03-12 21:04:01 +01:00
Vincent Prouillet
6eb8d34644
Merge pull request #951 from getzola/next
0.10.1
2020-03-12 20:59:20 +01:00
Andrew Barchuk
2e6d996709
Fix a pair of Tera links (#968) 2020-03-11 07:59:54 +01:00
Damian Carrillo
1a3e91f5f4
Fixing a missing link to Tera Filters (#966)
The previous link results in a 404. This is the updated link.
2020-03-09 08:15:18 +01:00
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
Aphek
cc67bf0c88
Change continue-reading to use a span with id instead of a named anchor in a paragraph (#941)
* Change continue-reading to use a span element instead of named anchor

* Fix all tests
2020-02-07 21:07:10 +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
Philipp Oppermann
72373bea9b Add path to TranslatedContent (#863)
* Add path to `TranslatedContent`

This makes it possible to retrieve the translated page through the `get_page` function.

* Use TranslatedContent::path field in test_site_i18n

Use it with the `get_page` function to get a reference to the page object.
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
Morgan
e8dc33ad08 fixes #844 duplicate entries in doc (#845) 2020-02-02 17:47:01 -08:00
Geobert Quach
3f166285de Paginator total pages (#829)
* feat(pagination): Add `total_pages` in paginator object

* feat(pagination): Added doc for `total_pages`

* feat(pagination): Added test for `total_pages`
2020-02-02 17:45:16 -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
Bob
4aa2ba84fc Let toc is visable through Page & Section variables in templates (#818)
* Let toc is visable through Page & Section variables in templates

* Removed the current toc variable from page & section
2020-02-02 17:44:38 -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
Einar
e194294664 Pages -> Page (#903) 2019-12-26 13:55:54 +01:00
Eduardo Pinho
1bafec4309 Update links to Tera documentation (#873)
- "/templates" section is gone upstream
2019-12-10 07:00:58 +01:00
David Authier
f4b6f63d3c 📝 Add TOML translations key example (#864) 2019-11-28 19:18:52 +01:00
Vincent Prouillet
35b567742c Ready for release 2019-09-24 19:12:13 -07:00
Arne Beer
f96aad2fdd Only shrink when resizing with fit (#803) 2019-09-24 16:54:14 -07:00
Vincent Prouillet
b16d525134 Mention feed_url in docs 2019-09-16 11:46:17 +02: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
fb89f94516 Process images on rebuild
Closes #790
2019-08-29 20:08:04 +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
Daniel Egger
beb5a3af41 Universalize the GitHub pages publishing scheme (#780)
Added instructions on how to publish to <username>.github.io or <org>.github.io by changing the publishing branch in the repo to `master`. This should work for any type of GitHub publishing, including custom domains.

Fixes #765
2019-08-24 19:06:07 +02:00
Vincent Prouillet
6a7e955ab0 Add lang to get_taxonomy & get_taxonomy_url 2019-08-15 22:14:53 +02:00
Joseph Price
36f4ad9a4b Missing argument in resize_image docs (#778) 2019-08-14 11: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
fd19469e40 Clarify a bit the pager term
Closes #775
2019-08-13 19:19:45 +02:00
Vincent Prouillet
7f459940e1 Allow multiple taxonomies with same name in different language
Closes #766
2019-08-10 18:54:32 +02:00
Vincent Prouillet
0e4e0c35b3 Remove all draft specific code 2019-07-19 11:10:28 +02:00
Hendrik Sollich
9f46048c0e Add Tomorrow theme (#749) 2019-07-16 17:22:02 +02:00
Vincent Prouillet
f5c7b44027 Add warning for old style internal link + fix one 2019-07-12 22:56:07 +02:00
Vincent Prouillet
666de5160e Fix Netlify auto-deploy instructions
Closes #745
2019-07-12 22:54:18 +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
Vincent Prouillet
f26f7719c6 Mention the id variable for the anchor link template
Closes #727
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
Avery Larsen
1cc0295637 Fix internal links (#743)
It looks like two links on this page didn't get updated with the change from `./` to `@/` in ec61a57.
2019-07-11 10:00:35 +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
Han Kruiger
4e8093c589
Fix mistake in Sorting Subsections documentation 2019-06-16 12:31:48 +02:00
Vincent Prouillet
0aee33f9c5 Add very copy/pasty impl of anchor checking 2019-06-06 19:49:40 +02:00
Vincent Prouillet
cb962f7a64 Add aliases to sections 2019-06-02 20:21:06 +02:00
Stuart Small
12d2576fba Fix for #632 - add ability to get asset image dimensions (#670) 2019-05-30 20:06:24 +02:00
Vincent Prouillet
ba6165fc47
Merge branch 'master' into next 2019-05-28 22:20:48 +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
93338c2762 Update changelog and version 2019-05-22 20:53:28 +02:00
Chris Morgan
1a9ab968fe Allow manual specification of header IDs (#685)
Justification for this feature is added in the docs.

Precedent for the precise syntax: Hugo.

Hugo puts this syntax behind a preference named headerIds, and automatic
header ID generation behind a preference named autoHeaderIds, with both
enabled by default. I have not implemented a switch to disable this.

My suggestion for a workaround for the improbable case of desiring a
literal “{#…}” at the end of a header is to replace `}` with `&#125;`.

The algorithm I have used is not identical to [that
which Hugo uses][0], because Hugo’s looks to work at the source level,
whereas here we work at the pulldown-cmark event level, which is
generally more sane, but potentially limiting for extremely esoteric
IDs.

Practical differences in implementation from Hugo (based purely on
reading [blackfriday’s implementation][0], not actually trying it):

- I believe Hugo would treat `# Foo {#*bar*}` as a heading with text
  “Foo” and ID `*bar*`, since it is working at the source level; whereas
  this code turns it into a heading with HTML `Foo {#<em>bar</em>}`, as
  it works at the pulldown-cmark event level and doesn’t go out of its
  way to make that work (I’m not familiar with pulldown-cmark, but I get
  the impression that you could make it work Hugo’s way on this point).
  The difference should be negligible: only *very* esoteric hashes would
  include magic Markdown characters.

- Hugo will automatically generate an ID for `{#}`, whereas what I’ve
  coded here will yield a blank ID instead (which feels more correct to
  me—`None` versus `Some("")`, and all that).

In practice the results should be identical.

Fixes #433.

[0]: a477dd1646/block.go (L218-L234)
2019-05-20 13:08:49 -07:00
Björn Lindström
8491110c4b Elaboration and imrovement in docs on paging (#692)
Added and clarified a few things that would probably have saved me from
raising getzola/zola#691.
2019-05-20 02:30:41 -07:00
Vincent Prouillet
290029aeed Fix a bit the pagination template doc 2019-05-18 17:55:10 -07:00
Vincent Prouillet
e21a102f89
Merge branch 'master' into next 2019-05-15 21:42:51 -07:00
Vincent Prouillet
a1a40574f6 Build syntax dumps 2019-05-14 08:52:12 -07:00
Vincent Prouillet
7337b38b96 Netlify support is back! 2019-05-09 09:23:17 -07:00
toidiu
5ae75033ac bump version in deployment docs (#680)
* bump version in deployment docs
2019-05-07 16:17:47 +02:00
Vincent Prouillet
b29596c3cc Mention the 404 page does not get current_path/current_url
Close #586
2019-05-01 23:06:05 +02:00
Vincent Prouillet
986437546c
Merge pull request #644 from getzola/next
v0.7.0
2019-04-28 10:41:12 +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
Wesley Moore
d4a33d34ae
Add some missing words to creating a theme page 2019-04-18 07:49:17 +10:00
Sven Thiele
47c02b50b3
Update netlify.md 2019-04-05 09:35:56 +02:00
Sven Thiele
28bf071b89
Update gitlab-pages.md 2019-04-05 09:34:40 +02:00
Sven Thiele
61c6d14ffb
update zola version to v0.6.0 2019-04-05 09:31:48 +02:00
Pandark
34c18e4cbb
use travis "minimal" vm in the documentation
If not specified, Travis use a system with ruby, which we don't need. We can use the "minimal" one instead.
2019-03-28 14:02:52 +01:00
Vincent Prouillet
33d4cf14fd
Update table-of-contents.md 2019-03-26 12:32:48 +01:00
Vincent Prouillet
78c8f9cd59 Add note about Powershell ISE
Closes #530
2019-03-25 23:17:37 +01:00
Vincent Prouillet
50caf1c90c Fix typo in docs
Closes #636
2019-03-25 23:15:53 +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
Vincent Prouillet
2a8d0de532 Pass extra for page in sitemap entries 2019-03-19 20:42:16 +01:00
Vincent Prouillet
c63b7fde44 load_data now defaults to plain type + fix bug with get_taxonomy fn 2019-03-16 10:01:11 +01:00
Vincent Prouillet
7baf08cef2 Update docs for sitemap 2019-03-14 21:15:01 +01:00
Vincent Prouillet
67ddabfa8b Fix doc mentioning non-existent fields on sections 2019-02-27 17:59:09 +01:00
Jordan Shurmer
bf1fd1a086
Fix minor documentation quirks in templates/overview 2019-02-27 08:54:09 -05:00
Vincent Prouillet
52cdffdfd4 Add PowerShell syntax
Fix #613
2019-02-25 18:11:30 +01: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
Vincent Prouillet
705a30aa8d Move toc to be a rendering page/section variable level 2019-02-09 20:49:18 +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
Peng Guanwen
07843c116f
Fix format mistake 2019-02-03 21:46:07 +08:00
Vincent Prouillet
1c7729cac6 Default lang to config.default_language 2019-01-29 19:20:11 +01:00
Shaleen Jain
3375e7a8f1 doc: add a Github Action to deploy to Github Pages 2019-01-23 13:43:29 +05:30
Vincent Prouillet
e119b68533 Remove earlier/later/lighter/heavier from pages when rendering sections 2019-01-21 17:55:05 +01:00
Vincent Prouillet
1b4cfd49d0 More early tera fns and mention limitation of shortcodes in docs 2019-01-17 18:29:18 +01:00
Ryan McGrath
0bcc706a55
One more time, Dracula theme, lol 2019-01-15 14:20:47 -08:00
Vincent Prouillet
538866487b Add multilingual taxonomies 2019-01-07 21:03:34 +01:00
Vincent Prouillet
cae9223ebd Mention that serve deletes the public dir as well 2019-01-07 19:24:08 +01:00
Vincent Prouillet
3d9c27e095 Tweak to docs to mention the paragraph id for continue-reading 2019-01-07 19:21:55 +01:00
Vincent Prouillet
0f0304d7ed Mention build rm the directory 2019-01-05 11:04:12 +01:00
Noumir.Poutipou
ee8087fe69 Correct a typo in the theme documentation 2019-01-04 22:00:58 +01:00
Vincent Prouillet
19075191ff Add translations to page/sections 2019-01-04 20:31:31 +01:00
Vincent Prouillet
fdb6a2864c
Merge pull request #566 from vojtechkral/imgproc
Implement suggestions in #546
2018-12-30 12:44:48 +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
Vojtech Kral
5348e6452e docs: Update image processing 2018-12-28 01:41:22 +01:00
Vincent Prouillet
4fb88a4056 Mention colon not allowed in filenames on windows 2018-12-18 19:46:25 +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
83fc3867ab Add Dart syntax highlighting 2018-12-04 19:00:18 +01:00
Matteo Guglielmetti
d4487381ff
Fixed name in Image Processing page 2018-12-03 17:31:53 +01:00
Vincent Prouillet
fb4c562088 Removing gutenberg completely from installation instructions 2018-11-30 22:23:18 +01:00
Vincent Prouillet
814cec99e2 Allow RFC3339 datetimes in filenames
Closes #537
2018-11-30 22:21:00 +01:00
Igor Kapkov
a6ec2b65c7
Update brew docs 2018-11-30 19:37:14 +11:00
Vincent Prouillet
b3004c69ef Fix broken taxonomies pagination
Closes #533
2018-11-29 20:24:46 +01: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
Andreas Reiser
644e53a3fd Extract zola version to a variable 2018-11-22 19:25:34 +01:00
Andreas Reiser
a07611d998 Add instructions on how to deploy to GitLab pages 2018-11-22 17:55:46 +01:00
Vincent Prouillet
34da6fdffd yaourt -> yay 2018-11-19 17:27:15 +01:00
Chris
cec89dea94
Fixed wrong heading
Changed arch linux from h2 to h3
2018-11-19 16:36:07 +01:00
Chris
a1aa7cb4c5
Updated install instructions
I updated the install instructions (snap, scoop, chocolatey) and added the ones where Gutenberg already got renamed to Zola also to the top of the document.

Should yaourt be replaced by one of the other aur-helpers (pikaur, yay,...) as the development for it is stalled/discontinued for quite some time now although it is still working?

Scoop: https://github.com/lukesampson/scoop/blob/master/bucket/zola.json
Chocolatey: https://chocolatey.org/packages/zola
Snap: https://snapcraft.io/zola
2018-11-19 16:34:39 +01:00
Sean Leather
93696bf4a4
Fix typo 2018-11-19 13:04:29 +02:00
Sean Leather
ed570627cf
Fix typo (missing 's') 2018-11-19 13:02:19 +02:00
Vincent Prouillet
29b8dffe27 Update docs for install/netlify deploy for zola/gutenberg 2018-11-12 19:58:46 +01:00
Vincent Prouillet
39bcbd70d0
Merge pull request #517 from gsomix/patch-1
Add info about chocolatey package
2018-11-12 14:24:05 +01:00
Evgeniy Andreev
070280021d
Add info about chocolatey package 2018-11-12 12:20:37 +04:00
Vincent Prouillet
7e4be8c126 Update syntaxes 2018-11-11 12:06:55 +01:00
Vincent Prouillet
1d97b24898
Merge branch 'master' into next 2018-11-07 19:45:03 +01:00
Vincent Prouillet
56af4ca7f9 Add page_template to sections
To override all child pages

Closes #397
Tests from PR #434
2018-11-07 19:42:23 +01:00
Vincent Prouillet
a3b0f1e103 Add transparent sections
Closes #413
Closes #408
2018-11-06 00:46:13 +01:00
Jake Howard
fef522bb29
Add links to tera documentation for filters and functions
Fixes https://github.com/Keats/gutenberg/issues/510. Well, should help with it.
2018-11-02 14:45:51 +00:00
Robert Masen
43cac703a3 add --watch-only to docs 2018-11-01 17:36:47 -05:00
Vincent Prouillet
c05f7c8362
Merge branch 'master' into next 2018-10-31 08:41:20 +01:00
Jake Howard
aad12d829f Remote data (#494) 2018-10-29 20:13:09 +01:00
Vincent Prouillet
9c66f77b05 Add manual download to netlify docs 2018-10-29 13:04:12 +01:00
Vincent Prouillet
8a6d3d42ec Add ayu highlighting theme 2018-10-26 20:04:56 +02:00
Vincent Prouillet
db4def63dc Set date from filename
Fix #396
2018-10-25 16:22:02 +02:00
Vincent Prouillet
f64e65ce7e Clarify redirect_to in docs
Fix #490
2018-10-19 12:14:20 +02:00
Vincent Prouillet
0101e5cb12 Update docs to refer to zola 2018-10-18 23:11:36 +02:00
Vincent Prouillet
83b04a561c Expose relative path of pages & sections
Closes #485
2018-10-18 18:00:40 +02:00
Luke Frisken
1baa7750f3 CSV and TOML loading global functions (#379)
Local CSV/TOML/JSON loading Tera function
2018-10-18 17:32:30 +02:00
Vincent Prouillet
86c418372f Add metadata_only to get_section 2018-10-18 16:49:33 +02:00
Vincent Prouillet
957c6bed9d Have a list of ancestors instead of only parent section 2018-10-18 15:54:51 +02:00
Vincent Prouillet
f14dbcbdf4 section.subsections is now an array of paths
Close #446
Close #260
Close #478
Close #284
Close #480
2018-10-15 22:28:27 +02:00
Vincent Prouillet
7ef4acbfbc Bundle the F# syntax 2018-10-15 11:56:03 +02:00
Vincent Prouillet
f920b873b8 Clarify where to use shortcodes 2018-10-13 11:15:19 +02:00
Vincent Prouillet
6b1c499f64 Add Reason syntax highlighting 2018-10-12 12:19:31 +02:00
Elias Roa
dd13f30a41 Minor documentation typo fixes 2018-10-10 15:21:58 -06:00
Chris Krycho
56c5036abc
Allow inclusion of all items in RSS feeds.
Switch to an `Option<usize>` for the serialized value of `rss_items`.
This lets us just set a blank value in the configuration and thereby
include *all* items.

This is a backwards-compatible change; it does not affect the behavior
of existing configurations.

Fixes #468. Closes #471.
2018-10-09 20:20:09 -06:00
Vincent Prouillet
0ce3a0f070
Merge pull request #459 from Keats/database
Slotmap refactor
2018-10-09 11:30:49 +02:00
Vincent Prouillet
5be4b822f9 Link to list of themes from themes docs 2018-10-08 13:08:41 +02:00
Jonathan Watt
4c96f2ec17 Fix the spelling of "macOS" 2018-10-07 18:17:33 +01:00
Vincent Prouillet
6843ec5c9c Rebuild more things now that it is more performant to do so
Fix #122
2018-10-06 13:52:40 +02:00
Greizgh
fec58054b4 Inject config in robots.txt context
This allow to use base_url in robots.txt, to reference a sitemap for
example.
2018-10-02 08:15:26 +02:00
Vincent Prouillet
e1aaed3c04 Remove paginator.pagers 2018-09-30 23:49:32 +02:00
Vincent Prouillet
f66a9425d2 Mention a paginated section doesnt get its pages 2018-09-29 11:15:50 +02:00
Greizgh
b8233af2c4 Allow to disable colors through env vars
- unless forced, only use colors in tty
- support CLICOLOR and NO_COLOR vars
- switch to termcolor crate to handle output coloring
2018-09-24 19:19:34 +02:00
Vincent Prouillet
cf5f22135f Some more info on installation 2018-09-18 12:13:00 +02:00
Vincent Prouillet
98ed34ec49
Removed outdated bit in rss docs 2018-09-17 11:32:54 +02:00
Vincent Prouillet
62b89d0c72 _processed_images -> processed_images 2018-09-15 13:16:46 +02:00
Matthias Endler
54b3ba4e11
Fix typo 2018-09-05 23:37:55 +02:00
Vincent Prouillet
014ce878f8
Merge pull request #368 from Keats/next
Next version
2018-09-03 19:39:10 +02:00
Vincent Prouillet
5ed489d4f2
Merge pull request #389 from Libbum/pagination
Update pagination for test_site posts
2018-09-02 21:34:16 +02:00
Cameron Dershem
15b74b2907 Updates docs to match proper toml syntax. 2018-08-29 18:56:21 -04:00
Vincent Prouillet
e0291cec65 Add Swift, MiniZinc syntax and update the rest
Also fix tests

Close #367, #372
2018-08-15 15:42:43 +02:00
Nathan Ringo
48391dbafb
extra_syntaxes documentation 2018-08-14 09:54:24 -05:00
Joe Clay
005e1f00b6
Update page variable list for custom taxonomies
I love the new support for custom taxonomies! I got a little thrown off when updating my site, though, as the docs didn't specify how the page would expose the taxonomies to the template. Wasn't too hard to figure it out, but I figured I'd save the next person who tries it the effort :)
2018-08-12 13:09:46 +01:00
cmal
7875387a04 Document assets on sections doc 2018-08-10 15:59:16 +02:00
cmal
ec65d01a72 Add assets to Sections variables 2018-08-10 15:59:03 +02:00
cmal
b8bc13c351 Make link more specific 2018-08-10 15:58:26 +02:00
cmal
26ffc31850 Document section assets + add example asset interaction from Markdown 2018-08-10 15:56:36 +02:00
Vincent Prouillet
3ddfc303ec Document extending theme templates (#361) 2018-08-05 11:49:50 +02:00
Vincent Prouillet
4f418a11b4 Fix live reload of section content 2018-08-05 10:30:01 +02:00
Vincent Prouillet
3db404c9f9 Update themes docs 2018-08-04 13:15:01 +02:00
Vincent Prouillet
84a3193e97 Last fixes 2018-08-03 19:47:39 +02:00
Vincent Prouillet
efddb24b95 We actually need get_taxonomy_url. Also update docs 2018-07-31 16:35:16 +02:00
Vincent Prouillet
9e3c66186b
Merge branch 'master' into next 2018-07-31 15:33:51 +02:00
Daniel Sockwell
554d50720c Update templates/pages-sections.md 2018-07-29 16:53:42 -04:00
Daniel Sockwell
bedf469d16 Update docs for removal of order 2018-07-29 15:55:03 -04:00
Vincent Prouillet
e83d76bf8a Clarify taxonomies templates doc 2018-07-27 18:44:10 +02:00
Nikita Puzankov
dc76e8c9a5
Fix typo in page.md doc
Fixed typo from 'ad' to 'at'.
2018-07-27 19:39:17 +04:00
Vincent Prouillet
056568dc61
Merge pull request #349 from codesections/manual_netlify
Expand Netlify doc page
2018-07-26 17:40:54 +02:00
Daniel Sockwell
ffe6f2b5f0 Expand Netlify doc page
This commit expands the Netlify documentation page to include a
description of how to manually deploy a built Gutenberg site from the
command line.
2018-07-25 13:42:46 -04:00
Daniel Sockwell
6905fd03f5 Expand documentation about sorting pages (#343) 2018-07-24 09:44:17 +02:00
Daniel Sockwell
18989747da Revise netlify.toml example
This is extremely minor, but the initial `netlify.toml` example confused
me a bit because I didn't realize that it was using a *netlify*
variable; I thought I needed to replace something with a variable from
my own configuration.  I made a very minor edit to the docs to clarify.
2018-07-23 17:10:50 -04:00
Daniel Sockwell
c2d4561f05 Edit docs to say that sections require an _index.md file (#341) 2018-07-20 09:16:57 +02:00
Vincent Prouillet
f37b19db6a Add archive docs
Fix #307
2018-07-17 17:58:59 +02:00
Vincent Prouillet
3e48ff24b5 Add an external link checker
Close #115
2018-07-16 21:15:50 +02:00
Vincent Prouillet
18bef00671 Rename taxonomies paginate and error on unknown ones 2018-07-16 18:14:48 +02:00
Vincent Prouillet
1ae0702494
Custom taxonomies (#330) 2018-07-16 10:54:05 +02:00
Daniel Sockwell
b563142fc0 Add index page section to documentation (#331)
* Add `index page` section to documentation

The current documentation does not describe how to create a index page.
I initially found this confusing, because I expected an index page to be
a **page** rather than a section.  Thus, I tried to access the page
content with `{{ page.content }}` and was very frustrated when I could
not.

This addition clarifies that the index page is **always** a section,
even if it does not have any sub-pages.  This should also help people
who intend to use Gutenberg to build stand-alone webpages, rather than
blogs.
2018-07-16 08:49:26 +02:00
Daniel Sockwell
9dd206d925 Edit docs to clarify role of static folder (#329) 2018-07-14 09:07:36 +02:00
Daniel Sockwell
1431df623f Edit docs to clarify RSS process
Add details to the templates/RSS page to clarify that the `rss.xml`
page is only generated if the `generate_rss = true` variable is set
in the site's `config.toml` page.  This information is already present
in other parts of the documentation, but is not present in the RSS page,
which could be confusing.
2018-07-08 11:21:24 -04:00
Vincent Prouillet
735bb38bd7 Update docs for 404 and enable preserve-order of tera 2018-07-05 17:43:48 +02:00
Vincent Prouillet
d47ba4aff0 Rebasing + tweaks 2018-06-25 19:13:21 +02:00
Vojtech Kral
17de3c9a97 imageproc: Rename _resized_images as _processed_images 2018-06-25 18:09:45 +02:00
Vincent Prouillet
8e8cdfeb7f Add year, month and day to page context with a date 2018-06-25 18:06:25 +02:00
Vojtech Kral
77bc526008 imageproc: Fix naming, cleanup 2018-06-25 18:05:49 +02:00
Vojtech Kral
7c8d39fe9c Docs for resize_image() 2018-06-25 18:05:04 +02:00
Vojtech Kral
6662014e55 Add image resizing support #225 2018-06-25 18:05:04 +02:00
Vincent Prouillet
3eb571fdbf Trim left every line of a shortcode to avoid the accidental markdown codeblock 2018-06-25 18:04:00 +02:00
Vincent Prouillet
d334b1cf46 More shortcode docs update 2018-06-25 18:03:20 +02:00
Vincent Prouillet
b120754862 Update shortcode parsing and docs 2018-06-25 18:02:21 +02:00
Clar Charr
da3b0fcf0e Use proper Unicode word count; fixes #304 2018-06-25 18:02:07 +02:00
James Munns
3694c43d3a Update documentation regarding aliases 2018-06-25 18:02:07 +02:00
Vincent Prouillet
165b06133a
Merge pull request #281 from maccoda/master
Theme deployment
2018-04-10 11:07:32 +02:00
Alexandru Scvortov
042765c129 obfuscate <!-- more --> in docs so that it doesn't get replaced 2018-04-09 22:23:27 +01:00
Dylan Maccora
a56ab5aa56 Theme deployment 2018-04-08 09:04:44 +10:00
Isaac Andrade
f9186118a0 Fix typo. 2018-04-03 10:24:53 -06:00
Isaac Andrade
486c979761 Fix documentation typos and minor changes:
- Fix some typos
- Some small changes to documentation to make it more clear
- Change the themes list from text to links
2018-04-01 18:33:59 -06:00
Vincent Prouillet
789a6408fb
Merge pull request #251 from Keats/next
Next version
2018-03-29 18:03:41 +02:00
Vincent Prouillet
e40e97711f Some more bits about continue_reading anchor 2018-03-28 17:01:14 +02:00
Tim DuBois
c8dfc5156a
Change naming convention 2018-03-27 07:38:04 +02:00
Tim DuBois
46115334c8
Documentation 2018-03-25 13:17:03 +02:00
Erich Gubler
72d50eed7f
Sass docs: try replacing // comments with # comments when they don't indicate output paths, try to resolve single-quote issue 2018-03-23 08:52:05 -06:00
Erich Gubler
b38a504094
Update _index.md 2018-03-22 15:47:34 -06:00
Erich Gubler
110e846fbe
Docs: add an entry for Sass processing in the main Content section 2018-03-22 15:46:40 -06:00
Vincent Prouillet
73ddbf7152 Write some docs 2018-03-21 16:18:24 +01:00
Vincent Prouillet
43db3a43ff Do not require themes to have a static folder 2018-03-18 09:34:37 +01:00
Vincent Prouillet
00729581f9 Break sorting ties by a-z ordering
Closes #259
2018-03-17 18:08:02 +01:00
Vincent Prouillet
3a2dab5974 Sort sitemap elements by permalink
Closes #257
2018-03-17 14:34:02 +01:00
Vincent Prouillet
1d81bbcfd7 Add small blurb about pagination activation 2018-03-17 13:58:32 +01:00
Adrien "pandark" Pachkoff
43bba8cbdb Remove quote around (empty) date in the example
Dates must not be surrounded by quotes.
2018-03-17 05:17:41 +01:00
Vincent Prouillet
2eacb8247b Fix config CLI option
Closes #254
2018-03-16 19:11:12 +01:00
Vincent Prouillet
217738d0c8 Update list of themes 2018-03-01 10:37:35 +01:00
Vincent Prouillet
f8b0720e39
Merge pull request #219 from Keats/docs-update
Docs update
2018-03-01 09:43:44 +01:00
Vincent Prouillet
af82a280f1 Fix link 2018-02-28 20:46:41 +01:00
Vincent Prouillet
6c09c8ba8b Slight tweak on theme docs 2018-02-28 20:44:30 +01:00
Vincent Prouillet
6a712969d4 Remove theme list from docs 2018-02-28 19:49:13 +01:00
Philip Daniels
3e1221064b Filter ignored content in page.rs.
* Add ignored_content to the Config structure.
* Use the GlobSet crate to parse the glob patterns into a matcher, which
  is created once at program initialization. If there are no patterns in
  ignored_content, an empty globber is created, which excludes no files.
  This is consistent with the existing behaviour of Gutenberg, before
  this feature was added.
* Bail if there are any errors in the glob patterns.
* Add a call to the globber in page.rs to actually do the filtering.
* Update documentation.

A note on the Config structure
------------------------------
* I had to remove the PartialEq derive from the Config structure as it
  does not work for the GlobSet type. No harm is done, Config does not
  need to be PartialEq anyway, since there is no need to sort Configs.
* The implementation follows the pattern of the existing config settings
  in that it uses an Option<...>. This would appear unnecessary, in that
  an empty vec could be used as the default, but it appears to be needed
  by the TOML parsing. A better approach would be to use a separate
  SerializableConfig and map to/from a Config struct. This would also
  allow the elimination of most, if not all, of the other Options in
  the Config structure, but that ought to be another PR.
2018-02-25 15:15:51 +00:00
Vincent Prouillet
b966a52dd1 Add credits to deploy github page 2018-02-22 19:03:00 +01:00
Vincent Prouillet
ec35d72b6f Add some deployment docs 2018-02-22 19:03:00 +01:00
Vincent Prouillet
f7cacba3f0 Update deps and changelog 2018-02-02 17:35:03 +01:00
Vincent Prouillet
54841b19bb
Merge pull request #220 from Keats/markdown-inline
Markdown inline
2018-02-02 17:29:16 +01:00