Giter Club home page Giter Club logo

beatrice's Introduction

beatrice

A simple static blog generator written in Go.

https://beatrice-example.surge.sh/

Installation

go get github.com/pprobst/beatrice

Or just download this repository and run go build or go install.

How do I even...?

After "getting" the package/repo, you can initially configure your blog by editing the file config.yml. It comes with some pre-defined configs just as an example.

There're mainly two directories you'll work with: about and posts.

about will hold a markdown file regarding yourself, while posts will, of course, hold your posts' markdown files. You can get started by looking at the pre-defined files; get used at how the header in each file must be written, and then... have some fun writing your own posts!

Running

When you're ready, just run beatrice. If everything went right, the message Fin. will be displayed. The generated files will be inside the static directory.


Inspirations

Todo

  • Better error handling, maybe.
  • Dedicated directory for images.

beatrice's People

Contributors

pprobst avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.