The cider is a simple tool of building GitHub pages. It's fast and easy to use.

Overview

The cider is a simple tool of building GitHub pages. It's fast and easy to use. See example: https://www.leyafo.com

Install

Compiling from source code:

go build -o cider main.go

Generate your site through Github Action(Recommending)

  1. Folk this project.
  2. Gernerate a SSH key for Github Action commit:
ssh-keygen -t rsa -b 4096 -C $(git config user.email) -f gh-pages -N ""

It will create two files: gh-pages and gh-pages.pub.
Copy all contents of the gh-pages.pub into Github/Setting/SSH and GPG keys/Add SSH Key.
ssh_public_key Copy all contents of the gh-pages into this project(your folkd)/Settings/Secrets/New repository secret. The name must be ACTIONS_DEPLOY_KEY. ssh_private_key. 3. Create a repository named your_name.github.io.
4. Copy the repository SSH url into this project(your folkd)/Settings/Secrets/New repository secret. The name must be DEPLOY_REPOSITORY.
ssh_repository_url

All done, happy writing.

You can empty all md files in content and all images files in rs/images, those are my demo contents. When you want to reference an image in your article, you should put the file in rs/images. It will be synced to your_name.github.io in which all md files are generated.

Notice: The CNAME file uploading and domain binding and other settings must be configured with yourself.

Showing your site on local

./cider s

Classify your articles

If you want to classify your articles into different groups, you should create a subfolder into content, and then add the folder link into templates/partials/_nav.html.tpl. For example, if you have written an article about English learning, and want to create a English Learning group in your website.

mkdir content/el
mv your_md_file content/el/

Add el into templates/partials/_nav.html.tpl

[ <a class="nav-btn" href="/el/">Englisha> ]
English ] " aria-label="Copy" class="ClipboardButton btn js-clipboard-copy m-2 p-0 tooltipped-no-delay" data-copy-feedback="Copied!" data-tooltip-direction="w">

Insert an image into your article

Create a images folder in public, copy your picture into the folder, write the relative path in your article.

![your_picture](/images/your_picture.jpg)

License

MIT

You might also like...
Give developers an easy way to create and integrate bank processing into their own software products
Give developers an easy way to create and integrate bank processing into their own software products

Community · Blog moov-io/bankcron Moov's mission is to give developers an easy way to create and integrate bank processing into their own software pro

Gin-easy-todo - golang 의 RESTful API 프레임워크 gin 을 활용해 아주 간단한 Todo 애플리케이션을 만들어보자.
Gin-easy-todo - golang 의 RESTful API 프레임워크 gin 을 활용해 아주 간단한 Todo 애플리케이션을 만들어보자.

목차 1. 요약 2. 목표 3. API 목록 4. 프로젝트 구조 5. 패키지 별 기능과 관계 6. 사전 작업 6.1. DB, Table 생성 6.2. 모듈 생성 6.3. 패키지 다운로드 7. Gin 작성 7.1. 데이터베이스 설정 7.2. 테이블, 스키마 정의 7.3.

Super lightweight, easy-to-develop, general purpose golang framework

Super lightweight, easy-to-develop, general purpose golang framework 🔥

Best lightweight, powerful and really fast Api with Golang (Fiber, REL, Dbmate) PostgreSqL

Best lightweight, powerful and really fast Api with Golang (Fiber, REL, Dbmate) PostgreSqL

[爬虫框架 (golang)] An awesome Go concurrent Crawler(spider) framework. The crawler is flexible and modular. It can be expanded to an Individualized crawler easily or you can use the default crawl components only.

go_spider A crawler of vertical communities achieved by GOLANG. Latest stable Release: Version 1.2 (Sep 23, 2014). QQ群号:337344607 Features Concurrent

Use of Advent of Code challenges to perform pyhton and learn Go language

Scripts in Python and Go language made to perform Advent of Code 2021 challenges

Analytics box a simple and privacy focused analytics tool written in go like google analytics
Analytics box a simple and privacy focused analytics tool written in go like google analytics

Analytics box is analytics tool like google analytics but instead of ripping user's privacy off them like google it respects their privacy and doesn't collect any unnecessary information.

A simple and privacy focused analytics tool written in go.
A simple and privacy focused analytics tool written in go.

Analytics Box Hello guys, this is privacy friendly analytics tool, Analytics Box for web written in go. It ensures user privacy but at the same time a

go-admin项目地址已经转移https://github.com/go-admin-team/go-admin
go-admin项目地址已经转移https://github.com/go-admin-team/go-admin

English | 简体中文 基于Gin + Vue + Element UI的前后端分离权限管理系统 系统初始化极度简单,只需要配置文件中,修改数据库连接,系统启动后会自动初始化数据库信息以及必须的基础数据 在线文档国际 在线文档国内 前端项目 视频教程 ✨ 特性 遵循 RESTful API 设

Owner
李亚夫
Truth more precisely, an accurate understanding of reality.
李亚夫
notion-md-gen allows you to use Notion as a CMS for pages built with any static site generators

notion-md-gen allows you to use Notion as a CMS for pages built with any static site generators

Bonaysoft 69 Dec 12, 2022
Simple vanilla Go CRUD application with mongoDB database with its mflix dataset that I use for my thesis about benchmarking REST API and GraphQL.

Go GraphQL Simple vanilla Go CRUD application with mongoDB database with its mflix dataset that I use for my thesis about benchmarking REST API and Gr

Adrian Edy Pratama 0 Oct 15, 2021
An easy, fluent way of building URLs via chainable methods written in Go(lang)

Burl - a fluent URL builder Burl provides an easy, fluent way of building URLs via chainable methods. How to install go get github.com/mr-cryka/burl Q

Daniel Krajka 0 Feb 5, 2022
Jump start with the golang, start building fast REST or GraphQL API's

personalized overview and instruction for everyday use golang projects and language structure.

Mainul Dip 0 Feb 7, 2022
A quick and easy password protected web server for your files. httpfolder makes downloading/uploading files from your current working directory easy, even for fairly large files.

httpfolder A quick and easy password protected web server for your files. httpfolder makes downloading/uploading files from your current working direc

null 14 Sep 12, 2022
Go-web-scaffold - A simple scaffold for building web app quickly

Go-web-scaffold A simple scaffold for building web app quickly. features This sc

Statrue 3 Jan 21, 2022
The world’s fastest framework for building websites.

A Fast and Flexible Static Site Generator built with love by bep, spf13 and friends in Go. Website | Forum | Documentation | Installation Guide | Cont

GoHugo.io 64.5k Dec 30, 2022
RSS master is a RSS subscription function aggregation tool, You can use it easily!

???? 中文 rsm ✨ RSS master[rsm] is a RSS subscription function aggregation tool, You can use it easily! How to start? ?? Start rsm with rsm run -c,--cfg

OSNT 7 Oct 18, 2022
Go kickstart is a simple repository that I'm managing to a have a fast setup for Go web application

Go kickstart is a simple repository that I'm managing to a have a fast setup for Go web application with my most common use cases using practices that I found useful and easy to maintain.

Sanjeya C 0 Jan 30, 2022
Goshort - Just another simple url shortener to use with curl

qnd.be Just another simple url shortener to use with curl. Kinda like 0x0.st. Ju

rune 0 Jan 29, 2022