https://github.com/coci/odin
static blog generator using github
https://github.com/coci/odin
blog gh-pages github go golang static
Last synced: 4 months ago
JSON representation
static blog generator using github
- Host: GitHub
- URL: https://github.com/coci/odin
- Owner: coci
- License: gpl-3.0
- Created: 2021-07-20T14:33:14.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-12-15T05:50:28.000Z (over 2 years ago)
- Last Synced: 2025-12-18T08:05:53.652Z (6 months ago)
- Topics: blog, gh-pages, github, go, golang, static
- Language: Go
- Homepage:
- Size: 236 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# odin
Odin is static blog engine written with golang. Odin uses github pages to deploy your blog.
### Requirements:
- support Unix (linux, MacOs , ....)
### Installation
``
go get github.com/coci/odin
``
## Usage :
1- first you need initialize odin :
```bash
odin init
```
2- you need configure odin :
```bash
odin config
```
3- you need make post:
```bash
odin new "how to work with odin"
```
this command will generate post template for you in :
``
path-to-blog-dir/content
``
4- you need to build your blog :
```bash
odin build
```
5- you have to push your blog :
```bash
odin push
```
## Consideration:
**note :** you need to run step 1 and 2 for once in lifetime.
**note :** you need to write your blog post in markdown format.
**note :** you can find post template ( file that you have to write your blog) in 'content' directory in root of blog.
**note :** everytime you change existing post or add new post you have to **build** and **push** again( step 4 and 5).
**note :** change CNAME file in root of project with your domain.