Commit graph

380 commits

Author SHA1 Message Date
Ilya Simpson
595713b91a Fix default FEED_DOMAIN: None -> SITEURL.
This is similar to how `AUTHOR_REGEX_SUBSTITUTIONS` is described, for
instance.
2025-07-21 20:22:27 +02:00
Justin Mayer
bfd1068b82
Merge pull request #3474 from clockback/use-lists-not-tuples 2025-07-05 07:48:57 +02:00
Ilya Simpson
fca2fde2ed Change lists, not tuples, in config settings
In the documentation, both `SOCIAL` and `LINKS` are described as a list
of tuples, but all examples show them as tuples of tuples. It makes the
most sense for them to be lists, so the examples should match the docs
going forward.

Similarly, `LOCALE` is described as a list, but the examples show it as
a tuple. Likewise, the examples should be lists, in line with the
description.
2025-07-04 20:06:44 +12:00
Ilya Simpson
b2ac0e93aa Fixing default SLUG_REGEX_SUBSTITUTIONS in docs.
Backslashes should not have been doubled, given the defaults are raw
strings.
2025-06-07 22:12:46 +12:00
Ilya Simpson
ffe22e3c59 Fixing documented default for ARTICLE_SAVE_AS. 2025-05-29 22:29:33 +12:00
Kristinita
7fd66d8a95
docs: Use raw string for the PATH_METADATA setting 2025-04-19 11:00:42 +03:00
Al Sweigart
9c7749a298
docs: Move default values to fix settings anchor links (#3458)
* Fix anchor links for settings by moving default value text down.
* Fix typos in default values.

---------

Co-authored-by: Justin Mayer <entroP@gmail.com>
2025-04-12 12:38:30 +02:00
Yashas Lokesh
543424aa41
fix: Fix auto-reload with globs in IGNORE_FILES (#3441)
The default `IGNORE_FILES` value of `'.*'` was being compiled to a regular expression and then passed into `watchfiles.DefaultFilter` to filter out files when auto-reload is enabled.

This commit compares the patterns from `IGNORE_FILES` directly with the filename to match the usage of `fnmatch` elsewhere in the codebase. The new filtering class will continue working as expected for custom `IGNORE_FILES` settings.
2025-01-15 17:40:27 +01:00
Alvin Mites
4878fc82a7
chore: Update link to re-directed example settings file (#3445) 2025-01-15 11:43:52 +01:00
David Lesieur
9207e1ff62
feat: Add setting to omit selected Typogrify filters. Fixes #3436 (#3439) 2025-01-14 12:48:39 +01:00
Angus Gratton
1edca55253 settings: Change the default IGNORE_FILES to all "hidden" files.
This is to avoid subtle behaviour that contributed to root cause of
https://github.com/pelican-plugins/sitemap/issues/36

Specifically: if installing Pelican into a local virtualenv with the pdm or uv
default name ".venv", then subdirectories of .venv will contain all of the test
.rst and .md files.

If you then run Pelican in that same root directory using the default PATH
value (".") then it will add those content files to the site.
2024-11-10 12:05:02 +11:00
Agathe
513abbfdc6
Introduce paragraph count summary (#2761)
Co-authored-by: Justin Mayer <entroP@gmail.com>
2024-06-25 15:07:41 +02:00
Justin Mayer
36ebe91af7 Rename default branch to main 2024-06-25 11:33:28 +02:00
GiovanH
0b5934a1fa
Feature: Add setting to append ref parameter to links in feeds (#3249) 2024-04-19 20:54:27 +02:00
Deniz Turgut
86d6898517
remove WRITE_SELECTED
Implementation is buggy and unreliable. Therefore, it is better to
remove the functionality until a robust implementation is added.
2023-11-12 19:43:26 +03:00
Paolo Melchiorre
6059675d55
Fix #3233 -- Simple theme classless semantic HTML 2023-11-11 14:10:08 +01:00
Justin Mayer
165d57eff5
Merge pull request #3127 from mart-e/no-inifinite-feed 2023-10-29 14:23:28 +01:00
Justin Mayer
85bf98232d
Merge pull request #3148 from djramones/period-archives-context 2023-10-28 22:22:11 +02:00
DJ Ramones
30adfba1ca
Revert *_ARCHIVE_URL default settings to blank 2023-08-17 02:35:39 +08:00
Justin Mayer
639173da6b Generalize analytics support in default theme
As the number of privacy-preserving analytics options proliferates,
it no longer makes sense to support specific solutions provided by
ad-tracking corporations.
2023-08-03 14:10:37 +02:00
Justin Mayer
dcd3045f32 Docs: Escape extra setting environment variables. Fix #3016 2023-08-03 10:21:54 +02:00
DJ Ramones
5214248344
Implement period_archives common context variable
Also, set default patterns for time-period *_ARCHIVE_URL settings.
2023-06-18 11:07:39 +08:00
Martin (mart-e)
bb682973fb Don't specify unlimited feed size by default
Having a feed with hundreds of articles, making a very large file, is
rarely expected.

Set a high fallback value of 100 so it does not change for small sites.

Still allow to have infinite feed by setting FEED_MAX_ITEM = None
2023-05-13 06:53:51 +02:00
Alex Peters
39e5edde9c Describe all CHECK_MODIFIED_METHOD options
Fixes #2991.
2022-06-16 13:36:59 +10:00
Victor Skvortsov
5c178a1ccb Fix #2938
Get rid of the coerce_overrides() function.
Add the ParseOverrides argparse.Action to parse overrides.
Treat all extra settings values strictly as json values.
Test overrides.
Edit docs and cli help.
2022-02-09 06:05:50 -07:00
Tristan Miller
82098a634f
Fix formatting of Jinja example code. Fixes #2884 (#2886) 2021-07-07 08:48:10 +02:00
Tristan Miller
e800b23b4d
Update links to Jinja docs. Fixes #2883 (#2885) 2021-06-12 08:48:32 -05:00
jzc
c41b8abb13 Fix FILENAME_METADATA doc to render correctly 2021-05-20 00:11:58 -06:00
Justin Mayer
4b6b5f0461 Clarify ARTICLE_ORDER_BY documentation 2021-02-19 09:31:04 +01:00
Tom Adler
89a31141ff Support last page pattern in PAGINATION_PATTERNS 2021-01-13 11:19:36 +01:00
Justin Mayer
4b79d6dae6 Update PyPI URLs to new equivalents 2020-11-20 15:46:05 +01:00
kernc
64fcdb5172
Rename setting SUMMARY_END_MARKER → SUMMARY_END_SUFFIX (#2792)
Avoids clash with 'summary' plugin.

Refs: https://github.com/getpelican/pelican-plugins/pull/1284#issuecomment-660715086
2020-08-19 20:25:19 +02:00
Justin Mayer
16975bc3a2 Prefix Pip commands with python -m in docs
This ensures Pip commands will be executed for the current Python
interpreter and not, say, whichever Python interpreter happens to be
associated with `/usr/local/bin/pip`.
2020-08-17 07:04:00 +02:00
Justin Mayer
45c5cb9029 Fix error in --extra-settings feature. Refs #2789 2020-08-13 12:07:58 +02:00
Justin Mayer
04c0ea53e6 Document -e / --extra-settings option flags 2020-08-11 12:51:08 +02:00
Justin Mayer
d2bbfd967e Remove self-referential Template Pages link in docs 2020-08-02 10:58:32 +02:00
Kernc
d6623c642f
Docs: minor fix code block indent 2020-06-05 14:28:11 +02:00
Justin Mayer
021ef45f75 Tidy SLUGIFY_* settings documentation 2020-04-21 05:36:28 +02:00
Deniz Turgut
bd699d34e8 Expose preserve_case option from slugify 2020-04-21 00:26:00 +03:00
Deniz Turgut
97fe235e60 Expose use_unicode setting of slugify in settings and use it 2020-04-19 20:21:00 +03:00
fancsali
f610801ee8
Add Typogrify/SmartyPants dashes config parameter (#2615) 2020-04-16 13:32:19 +02:00
Justin Mayer
e18c9d2c60 Remove Piwik from theme and settings docs
Name has been changed, and rather than fix it, it makes more sense to
deprecate analytics in Pelican core and relegate them to plugins/themes.
2020-04-16 08:26:09 +02:00
Cropse
7e52b61934
Enhance JINJA_FILTERS setting docs (#2126) 2020-04-15 10:42:21 +02:00
David Zaslavsky
9eb259af82
Wrong path for attached static content urls (#2158)
* Document _URL/_SAVE_AS path matching req. Fix #2158

This commit addresses the fact that some URLs (primarily {attach}) are based
on the *_SAVE_AS path instead of the *_URL path. It updates the documentation
to point out that the paths of corresponding _URL and _SAVE_AS settings should
match, and that the OUTPUT directory should correspond to the web server's
document root, in order to avoid producing these incorrect URLs.

* Clarify {attach} and *_URL / *_SAVE_AS caveat

Co-authored-by: Justin Mayer <entroP@gmail.com>
2020-04-15 10:35:04 +02:00
Justin Mayer
7d19bcf5d4
Add settings for custom Jinja globals and tests (#2715)
Pelican has a setting for custom Jinja filters but not custom tests or
custom environment namespace globals. This adds both of the latter.
2020-04-12 17:03:53 +02:00
Kurt McKee
7bbd3dc6fb
Update links to HTTPS and current 301 redirects in docs/templates/themes (#2661)
This also updates the Tumblr API to use HTTPS as documented in the
current Tumblr API docs.
2020-04-12 16:38:35 +02:00
Justin Mayer
5b238d189c
Merge pull request #2666 from xuhdev/doc/themes
doc: Add cross links between theme settings and pelican-themes
2020-04-12 08:53:54 +02:00
Justin Mayer
9d8a143ce8
Merge pull request #2660 from kurtmckee/fix-pagination-docs-typo
Fix a typo in the pagination settings docs
2020-04-12 07:17:32 +02:00
(GalaxyMaster)
4833a27243 Provided the settings documentation snippet 2020-04-11 15:42:18 +10:00
Justin Mayer
b8f2326fa6 Document mirroring content & output path hierarchies 2019-12-28 10:02:48 +01:00