1
0
Fork 0
forked from github/pelican
Commit graph

39 commits

Author SHA1 Message Date
Justin Mayer
36ebe91af7 Rename default branch to main 2024-06-25 11:33:28 +02:00
Justin Mayer
7a2c72e604
Merge pull request #3337 from getpelican/document-feed-domain-optional 2024-06-17 22:22:59 +02:00
Justin Mayer
05535c7d6c Docs: GitHub Pages workflow is now supported 2024-06-17 22:19:21 +02:00
Sean Hammond
853e9e6b8a
Document that feed_domain is not required 2024-06-17 20:46:28 +01:00
Sean Hammond
135c61f769
Add Dependabot to GitHub Actions workflow docs 2024-06-17 16:38:10 +01:00
Sean Hammond
e46595cdac
Add theme, Python version, siteurl and feed_domain to GitHub Pages deployment workflow
Add theme, Python version, siteurl and feed_domain support to the
reusable GitHub Actions workflow for deploying a Pelican site to GitHub
Pages:

1. Add a new `theme` option to the workflow that callers can use to
   specify an external theme to be checked out and used

2. Add a new `python` option to the workflow that callers can use to
   specify the Python version, in case they need to build their site
   with a particular version of Python

3. Pass `--extra-settings FEED_DOMAIN='"${{ steps.pages.outputs.base_url }}"'`
   to the `pelican` command to set the value of Pelican's `FEED_DOMAIN`
   setting for feed URLs.

4. Add a `feed_domain` input to the workflow so that users can override
   the feed domain if they need to.

5. Add a `siteurl` input to the workflow so that users can override the
   site URL if they need to.

6. Add a note to the docs about GitHub Pages generating http:// URLs for
   https:// sites, and how to fix it

7. Some light editing of the docs for the workflow
2024-06-17 13:57:10 +01:00
Justin Mayer
e4d7f0a9d9 Docs: GitHub Pages workflow not officially supported 2024-05-29 07:29:33 +02:00
Deniz Turgut
6f1605edf9
Extend GHA documentation to specify requirements file 2023-10-29 18:30:25 +03:00
Sean Hammond
29185e4ad7
Add GitHub Actions workflow for GitHub Pages
Add a GitHub Actions workflow that users can use to publish their
Pelican sites to GitHub Pages by running `pelican` on GitHub Actions,
without having to run `pelican` locally and push the output directory to
a branch.

See: https://github.com/getpelican/pelican/discussions/3174
2023-09-03 15:15:39 +01:00
Tim Gates
6cac8237cc
docs: Fix a few typos
There are small typos in:
- docs/tips.rst
- pelican/tests/__init__.py

Fixes:
- Should read `module` rather than `modulole`.
- Should read `console` rather than `cosole`.

Signed-off-by: Tim Gates <tim.gates@iress.com>
2022-07-24 07:55:18 +10:00
MinchinWeb
58e3770b80 Document how to add a new writer
c.f. #2899
2021-07-09 08:28:15 -06:00
Justin Mayer
e35120faa8
Merge branch 'master' into line-limit 2018-11-03 16:18:25 +01:00
MinchinWeb
f9c3ac73e0 Docs: ghp-import works on Windows now
see https://github.com/davisp/ghp-import/pull/25
2018-11-02 20:55:33 -06:00
MinchinWeb
f595741b8e Docs: Reflow to 79 char line limit 2018-11-02 20:53:15 -06:00
Justin Mayer
6224f95ea3
Merge pull request #2147 from outlace/patch-1
Enhance GitHub User Pages docs in tips.rst
2018-10-24 08:42:36 +02:00
Bernardo Gomes
31fd6c6da6 ghp-import ouput update the branch gh-pages 2018-07-29 19:26:03 -03:00
Kevin Deldycke
c04a4701b8 Replace Fabric by Invoke. 2018-07-08 21:33:10 +02:00
Anthony Metzidis
12db9ba0e1 support ssl in pelican.server with --ssl, --cert & --key 2018-04-07 15:06:38 -07:00
Brandon B
32c154be95 Update tips.rst
I found that one of the easiest ways to publish to GitHub User Pages is to make Pelican a subdirectory within the ``<username>.github.io`` project, then generate the output files in the root level of ``<username>.github.io`` and push the entire project to GitHub.
2017-04-28 19:18:44 -07:00
Sjoerd
d61e2ccd6b Use better headers in tips docs
Instead of "Tip 1", "Tip 2" under "Extra tips", use headers describing
the content.

Also, remove the "hint" pointer as it is not really a hint and the
document consists of tips anyway.
2017-01-14 13:51:10 +01:00
Justin Mayer
ac08cd5eb1 Docs: Custom 404 pages are pages -- not articles 2016-09-15 06:55:25 -06:00
Jotham Apaloo
aa318a1366 Update tips.rst
add 404 page instructions for amazon s3.
2015-07-06 21:52:19 -04:00
Justin Mayer
d19854f4dc Remove references to easy_install in documentation 2015-06-15 07:08:05 -07:00
Justin Mayer
bfbb7d4bb5 Merge pull request #1581 from georgevreilly/win-fixes
Fix Pelican rendering and unit tests on Windows.
2015-02-17 17:06:19 -08:00
George V. Reilly
4c25610cd8 Fix Pelican rendering and unit tests on Windows.
* Fix {filename} links on Windows.
  Otherwise '{filename}/foo/bar.jpg' doesn't work
* Clean up relative Posix path handling in contents.
* Use Posix paths in readers
* Environment for Popen must be strs, not unicodes.
* Ignore Git CRLF warnings.
* Replace CRLFs with LFs in inputs on Windows.
* Fix importer tests
* Fix test_contents
* Fix one last backslash in paginated output
* Skip the remaining failing locale tests on Windows.
* Document the use of forward slashes on Windows.
* Add some Fabric and ghp-import notes
2015-01-25 17:42:53 -08:00
Shrayas
38c307eefd Add link to GitHub docs on custom 404 pages 2015-01-11 19:18:34 -08:00
Justin Mayer
cff5f3e774 Add custom 404 page to Tips section of docs 2015-01-11 18:54:15 -08:00
Salil Panikkaveettil
97766ba1f4 For creating a CNAME, directory name should be extra
The name of the directory do not match subsequent commands. hence renaming extras to extra. A one character change
2013-11-19 16:49:37 +05:30
Kevin Deldycke
6c808e426f Document video support in Markdown and reST. 2013-10-25 10:52:13 +02:00
Justin Mayer
f6c9237a01 Enhance and correct documentation 2013-09-23 19:30:51 +02:00
Talha Mansoor
13199792a7 Add tip on how to add videos to your blog. 2013-09-08 23:05:52 +02:00
Justin Mayer
5d000ca290 Add more missing -s flags to tips doc page 2013-06-26 06:39:09 -07:00
Justin Mayer
7d37cfa748 Missing -s flag added to command on tips doc page 2013-06-25 19:17:40 -07:00
Éric Lemoine
369bb476e9 Improve Publishing to GitHub section of the doc 2013-01-01 01:01:19 +01:00
Justin Mayer
9dcf4e5438 Eliminate extraneous whitespace 2012-10-12 23:01:50 +02:00
Justin Mayer
9ad93d36a0 Convert code in docs to inline literals
Most of the references to code and settings in the docs were wrapped
in single tickmarks (`), while reStructuredText syntax actually calls
for double tickmarks for inline literals, which are normally rendered
as monospaced text with spaces preserved. Converted the relevant
instances to inline literals, along with some other minor fixes.
2012-07-01 10:52:39 -07:00
Abhishek L
219280d203 Updated docs, for user and project pages in Github 2012-06-10 00:00:49 +05:30
Justin Mayer
bde06c4011 Improve English documentation with enhanced clarity, grammar, and spelling 2012-03-06 06:13:17 -08:00
Alexis Metaireau
100d94cd12 add ghp-import features to push to github pages easily 2011-08-19 23:01:01 +02:00