https://github.com/vdmitriyev/blog
Personal blog with markdown
https://github.com/vdmitriyev/blog
Last synced: 5 months ago
JSON representation
Personal blog with markdown
- Host: GitHub
- URL: https://github.com/vdmitriyev/blog
- Owner: vdmitriyev
- License: mit
- Created: 2024-03-05T10:29:53.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-08T13:00:49.000Z (almost 2 years ago)
- Last Synced: 2024-07-08T20:04:55.401Z (almost 2 years ago)
- Language: Python
- Size: 7.29 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### About
Original articles of the following blog http://vdmitriyev.github.io/blog/ in the markdown format configured to be compiled with ```pelican``` and deployed/commited to the github.
## Usage
* Install [pelican](https://github.com/getpelican/pelican) python package
```bash
pip install pelican
```
* For configs check ```pelicanconf.py```
* Compile markdown files into html. Two options are available (a) ```localhost``` and (b) ```github account``` file.
```bash
pelican content
```
* (alternative) use pre-shipped ```bat``` script ```scripts/compilePelican.bat```
* Run simple HTTP server to check the results
```bash
cd ..
python -m http.server 5151 --bind 127.0.0.1
```
* (alternative) use internal web server from pelican
```
pelican -r --listen
```
* (alternative) use pre-shipped ```bat``` script
```scripts/startSimpleHTTP.bat```
### Deploy with Github Actions
* Personal configurations - create a Github tokens for (Settings -> Secret and variables -> Actions):
+ GOOGLE_ANALYTICS =
+ PELICAN_THEME_REPO = https://github.com/vuquangtrong/simplify-theme
+ PELICAN_THEME_NAME = simplify-theme
* Activate ```gh-pages``` in the git repository: Settings -> Pages -> Branch (set to ```gh-pages``` and ```/root```)
### Deploy Locally
###### Personal Config
You need to create ```personal_configs.py``` file and fill following fields:
```text
GOOGLE_ANALYTICS = u'UA-'
```
More about configs and configs themselves you can find in pelican's [quickstart](https://docs.getpelican.com/en/latest/quickstart.html)
###### Add Theme + Plugins
* Review themes
+ Github (all themes) - https://github.com/getpelican/pelican-themes
+ Github (selected themes)
- https://github.com/vuquangtrong/simplify-theme
* Review plugins
+ Github (all plugins) - https://github.com/orgs/pelican-plugins/repositories
* Install themes (e.g, ```simplify-theme```)
```
git clone https://github.com/vuquangtrong/simplify-theme
pelican-themes --install simplify-theme
```
### Author
* Viktor Dmitriyev