diff options
| author | Justin Mayer <entroP@gmail.com> | 2019-09-28 13:51:20 -0700 |
|---|---|---|
| committer | Justin Mayer <entroP@gmail.com> | 2019-09-28 13:51:20 -0700 |
| commit | 047d884323a67495a4358acee984b276d3456f07 (patch) | |
| tree | fbe16edd8da22592594cba8e8a5c73505b43b5d5 /docs | |
| parent | db04f012971f154c3f7601ced1d666bee0ea8da9 (diff) | |
| download | pelican-047d884323a67495a4358acee984b276d3456f07.tar.gz | |
Fix quick-start docs regarding `pelican --listen`
Reverts 2ab91bbaaa565dcb89726b6cac0002c1e0644dc3 and resolves #2626
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/publish.rst | 16 | ||||
| -rw-r--r-- | docs/quickstart.rst | 6 |
2 files changed, 7 insertions, 15 deletions
diff --git a/docs/publish.rst b/docs/publish.rst index 96d67d58..489558d8 100644 --- a/docs/publish.rst +++ b/docs/publish.rst @@ -54,20 +54,12 @@ HTML files directly:: firefox output/index.html Because the above method may have trouble locating your CSS and other linked -assets, running a simple web server using Python will often provide a more -reliable previewing experience. +assets, running Pelican's simple built-in web server will often provide a more +reliable previewing experience:: -For Python 2, run:: + pelican --listen - cd output - python -m SimpleHTTPServer - -For Python 3, run:: - - cd output - python -m http.server - -Once the basic server has been started, you can preview your site at +Once the web server has been started, you can preview your site at: http://localhost:8000/ Deployment diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 4ad9416f..646dd987 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -50,18 +50,18 @@ Given that this example article is in Markdown format, save it as Generate your site ------------------ -From your site directory, run the ``pelican`` command to generate your site:: +From your project root directory, run the ``pelican`` command to generate your site:: pelican content -Your site has now been generated inside the ``output`` directory. (You may see +Your site has now been generated inside the ``output/`` directory. (You may see a warning related to feeds, but that is normal when developing locally and can be ignored for now.) Preview your site ----------------- -Open a new terminal session, navigate to your generated output directory and +Open a new terminal session, navigate to your project root directory, and run the following command to launch Pelican's web server:: pelican --listen |