https://github.com/alexioannides/alexioannides
Python source code for generating my website at alexaioannides.github.io.
https://github.com/alexioannides/alexioannides
pelican python website
Last synced: 11 months ago
JSON representation
Python source code for generating my website at alexaioannides.github.io.
- Host: GitHub
- URL: https://github.com/alexioannides/alexioannides
- Owner: AlexIoannides
- Created: 2018-09-10T05:55:51.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-05-22T22:39:46.000Z (about 2 years ago)
- Last Synced: 2025-05-30T04:58:38.740Z (about 1 year ago)
- Topics: pelican, python, website
- Language: CSS
- Size: 9.94 MB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# alexioannides
Python source code for generating my personal website - hosted by GitHub pages at [alexioannides.github.io](http://alexioannides.github.io) - using the [Pelican](https://blog.getpelican.com/) framework for static websites, together with [Flex theme](https://github.com/alexandrevicenzi/flex).
The output of the build process is written to the `output` folder in the root directory, that is **not** version controlled using this repository. Instead, the `output` directory has its own repository at [alexioannides](https://github.com/AlexIoannides/alexioannides), that is necessary for hosting with GitHub pages.
## Development Setup
The package's 3rd party dependencies are described in `requirements.txt`. Create a new virtual environment and install these dependencies as follows,
```bash
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
```
## Building the Website
To build the website we need to call Pelican,
```bash
pelican
```
## Testing the Site Locally
We recommend setting `RELATIVE_URLS = True` when testing (do not forget to revert this before deploying) and then executing the following,
```bash
pelican --listen output
```
A test version of the website will then be available at `http://localhost:8000`.
## Deploying to GitHub Pages
After testing locally, first of all ensure that `RELATIVE_URLS = False`, rebuilding the website if necessary. Then, make sure that you are still in the `output` directory and remember that this is version controlled by a [different repository](https://github.com/AlexIoannides/alexioannides.github.io), that now needs new changes to be committed and pushed to `master` as usual - e.g.,
```bash
git add -A
git commit -m "latest changes to alexioannides.github.io"
git push origin master
```
The [updated website](http://alexioannides.github.io) is usually available within a minute or two.