This commit is contained in:
tuba javed 2026-04-15 08:15:55 +02:00 committed by GitHub
commit 4a2ae1e4df
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -68,7 +68,6 @@ automatically installed without any action on your part:
broadcast signaling system
* `unidecode <https://pypi.org/project/Unidecode/>`_, for ASCII
transliterations of Unicode text
utilities
* `MarkupSafe <https://pypi.org/project/MarkupSafe/>`_, for a markup-safe
string implementation
* `python-dateutil <https://pypi.org/project/python-dateutil/>`_, to read
@ -85,6 +84,30 @@ the latest stable release, you can do so by adding ``--upgrade``::
If you installed Pelican via distutils or the bleeding-edge method, simply
perform the same step to install the most recent version.
Windows notes
-------------
Git Bash users may encounter::
bash: pelican-quickstart: command not found
This occurs because Git Bash does not automatically include Pythons Scripts
directory in ``PATH``.
**Recommended options:**
* Use **PowerShell** instead of Git Bash
* Use **WSL (Windows Subsystem for Linux)** for a Linux-like environment
**Alternative workarounds:**
* Ensure Pythons Scripts directory is in ``PATH``
* Run Pelican via::
python -m pelican
See issue #3574 for discussion.
Kickstart your site
-------------------
@ -98,8 +121,9 @@ If run inside an activated virtual environment, ``pelican-quickstart`` will
look for an associated project path inside ``$VIRTUAL_ENV/.project``. If that
file exists and contains a valid directory path, the new Pelican project will
be saved at that location. Otherwise, the default is the current working
directory. To set the new project path on initial invocation, use:
``pelican-quickstart --path /your/desired/directory``
directory. To set the new project path on initial invocation, use::
pelican-quickstart --path /your/desired/directory
Once you finish answering all the questions, your project will consist of the
following hierarchy (except for *pages* — shown in parentheses below — which
@ -115,8 +139,8 @@ content)::
├── pelicanconf.py # Main settings file
└── publishconf.py # Settings to use when ready to publish
The next step is to begin to adding content to the *content* folder that has
been created for you.
The next step is to begin adding content to the *content* folder that has been
created for you.
.. _Pip: https://pip.pypa.io/
.. _virtualenv: https://virtualenv.pypa.io/en/latest/