From 77567dc670b64638adcd24fbda5f00851c744d61 Mon Sep 17 00:00:00 2001 From: Tuba Javed Date: Sat, 21 Feb 2026 13:07:32 +0530 Subject: [PATCH 1/2] Add Windows Git Bash troubleshooting instructions for pelican-quickstart --- docs/install.rst | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/docs/install.rst b/docs/install.rst index 502148ed..567cf2ca 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -1,5 +1,40 @@ Installing Pelican ################## +Using Pelican on Windows +------------------------ + +If you are using **Git Bash** on Windows, you may encounter: + + bash: pelican-quickstart: command not found + +**Reason:** Bash does not automatically recognize Python’s Scripts folder on Windows. + +**Solutions:** + +1. **Use PowerShell** (recommended) instead of Git Bash: + + pelican-quickstart + +2. **Use WSL** (Windows Subsystem for Linux) if you prefer a Linux-like environment. + +3. **Check your PATH**: On PowerShell, if you get: + + : The term '' is not recognized as a name of a cmdlet, function, script file, or executable program. + + then the Python Scripts folder may not be in your PATH. Add it: + + C:\Users\\AppData\Local\Programs\Python\Python312\Scripts + +4. **Alternative quickfix:** Run the scripts directly with Python: + + py C:\Users\\AppData\Local\Programs\Python\Python312\Lib\site-packages\pelican\tools\pelican_quickstart.py + py -m pelican -r -l + +------------------------------- +Kickstart your site +------------------- + + Pelican currently runs best on |min_python|; earlier versions of Python are not supported. From 964377d28fa7896ee073cf21ae2742a5f723e5a3 Mon Sep 17 00:00:00 2001 From: Tuba Javed Date: Sun, 1 Mar 2026 23:28:44 +0530 Subject: [PATCH 2/2] changes in file -> docs/install.rst --- docs/install.rst | 69 ++++++++++++++++++++---------------------------- 1 file changed, 29 insertions(+), 40 deletions(-) diff --git a/docs/install.rst b/docs/install.rst index 567cf2ca..66ae9c03 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -1,40 +1,5 @@ Installing Pelican ################## -Using Pelican on Windows ------------------------- - -If you are using **Git Bash** on Windows, you may encounter: - - bash: pelican-quickstart: command not found - -**Reason:** Bash does not automatically recognize Python’s Scripts folder on Windows. - -**Solutions:** - -1. **Use PowerShell** (recommended) instead of Git Bash: - - pelican-quickstart - -2. **Use WSL** (Windows Subsystem for Linux) if you prefer a Linux-like environment. - -3. **Check your PATH**: On PowerShell, if you get: - - : The term '' is not recognized as a name of a cmdlet, function, script file, or executable program. - - then the Python Scripts folder may not be in your PATH. Add it: - - C:\Users\\AppData\Local\Programs\Python\Python312\Scripts - -4. **Alternative quickfix:** Run the scripts directly with Python: - - py C:\Users\\AppData\Local\Programs\Python\Python312\Lib\site-packages\pelican\tools\pelican_quickstart.py - py -m pelican -r -l - -------------------------------- -Kickstart your site -------------------- - - Pelican currently runs best on |min_python|; earlier versions of Python are not supported. @@ -103,7 +68,6 @@ automatically installed without any action on your part: broadcast signaling system * `unidecode `_, for ASCII transliterations of Unicode text - utilities * `MarkupSafe `_, for a markup-safe string implementation * `python-dateutil `_, to read @@ -120,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 Python’s 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 Python’s Scripts directory is in ``PATH`` +* Run Pelican via:: + + python -m pelican + +See issue #3574 for discussion. + Kickstart your site ------------------- @@ -133,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 @@ -150,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/