If you are like me, you probably want to blog from the command line with your favorite text editor instead of going to a website and use a random editor that probably will not help you as much as you wanted. This is why I wrote this: I want to use Github as the database for my blog. The idea is:
- Create a Github repository to store your posts.
- In your website, include the Javascript files to load and retrieve blog posts.
Simple, right? Now let's get into the details...
Your posts repository must contain an index.blog.json file organized as a list of JSON objects containing at least the following fields:
path: indicates what is the path to the file containing the post datatitle: contains the blog post titledescription: shortly describes what your post is about
The remaining files can blog posts in whatever format you want (as long as you are able to use it).
To use the github-blog library, use GitCDN to enable the use of the GithubBlog variable. It will probably look like this:
<script src="https://www.gitcdn.xyz/repo/liberdade-organizacao/github-blog/master/github-blog.min.js"></script>
<script>
var postLink = '';
var blog = new GithubBlog('liberdade-organizacao/posts');
blog.loadIndex(function(index) {
postLink = index[0].path;
});
blog.loadPost(postLink, function(post) {
console.log(post);
});
</script>To run unit tests, you will need:
- A simple HTTP server
Run your favorite HTTP server (I suggest python -m http.server 8000 or ruby -run -e httpd . -p 8000 though) in the root folder of this repository and access the test.html. It will run the unit tests for this project using Mocha and Chai.