Skip to content

valgreens/go-polo

 
 

Repository files navigation

go-polo

Disclaimer: this project is in a really early state. You can generate your own blog and navigate between pages but I am sure that you are going to miss some other functions. If you want a simple blog, you CAN use it without any problem.

What's it?

It's a static blog rendering tool. Yes, I know that there a lot of them out there but I just want mine to learn a little bit of Go coding.

How to use it

For now I am not providing binaries, you will need to compile it yourself, but you can use build.sh:

$ rm bin/go-polo;./build.sh;bin/go-polo -help
  Usage of bin/go-polo:
    -config="config.json": the settings file to create your site.
    -input=".": path to your articles source files.
    -output=".": path where you want to creat the html files.

If you want try it with the examples:

$ bin/go-polo -input examples -output /tmp
$ cd /tmp
$ python -m SimpleHTTPServer

And now, you can go to http://localhost:8000 and see your generated blog.

Supported format

Yes, format. Without the -s.

I am using markdown only. Whatever thing that is supported by blackfriday library is supported here. The only difference is that I am adding some metadata to the files. For example, if you want to define the date for the file:

---
date: Monday, 4th April XXYY
tags: place, Mancha, name
---

And here is just the title.

It's really important that you let a line between the --- and the beginning of your article.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published