fungo

     ____
    / __/  __  __   ____    ____ _  ____
   / /_   / / / /  / __ \  / __  / / __ \
  / __/  / /_/ /  / / / / / /_/ / / /_/ /
 /_/     \__,_/  /_/ /_/  \__, /  \____/
                        /____/ v0.3.0

Overview

fungo is a simple and fast open-source static site generators base on golang.

install

go get

go get github.com/fundipper/fungo

docker

docker pull fundipper/fungo

command

fungo is easy to use, only have 5 commands.

site

create a new site

fungo site your-site-name

docker

docker run -it --rm -v $PWD:/fungo fundipper/fungo site your-site-name

file

create a new file

fungo file your-file-model your-file-name

docker

docker run -it --rm -v $PWD:/fungo -w /fungo/my-fungo-site fundipper/fungo file your-file-model your-file-name

ps:

default file model include [article , page, document]

you can define your own file model with yaml in source

theme

create a new theme

fungo theme your-theme-name

docker

docker run -it --rm -v $PWD:/fungo -w /fungo/my-fungo-site fundipper/fungo theme your-theme-name

ps:

usually, you can get theme from fungo theme store or some open source repository

if you need your own one, use this command to create it

it's not too complicated, only needs tailwindcss

serve

run serve mode

fungo serve

docker

docker run -it --rm -v $PWD:/fungo -w /fungo/my-fungo-site -p 3000:3000 fundipper/fungo serve

build

run build mode

fungo build

docker

docker run -it --rm -v $PWD:/fungo -w /fungo/my-fungo-site fundipper/fungo build

document

ours official website, document, theme, blog are all generate based on fungo

how to use fungo ? see https://fungo.dev/doc/overview/

feature

• Support

  • Article

  • Page

  • Document

  • Customize

  • I18N

• Markdown

  • TOC

  • META

  • Emoji

  • GFM (Table，Strikethrough，Linkify，TaskList)

  • DefinitionList

  • Footnote

  • Typographer

  • Mathjax

  • Mermaid

  • Highlighting

  • Image Lazyload

  • Link Reset

  • Video Embed

• Feeds

  • RSS 2.0

  • Atom 1.0

  • JSON 1.1

• SEO

  • Sitemap.xml

  • Robots.txt

Thanks

• Language & Frameworkexport GOPROXY=https://goproxy.cn

  • golang

  • tailwindcss

  • alpinejs

• Tools & Libraries

  • cobra

  • viper

  • goldmark

  • ristretto

  • httprouter

  • fsnotify

  • copy

  • go-git

  • etree