PINP Blog: A Free Blog System with Github-based

Product version: 1.0
Chinese version: 习惯看中文的朋友请点这里

Introduce

PINP (PINP Is Not PPT) is PPT-like presentation system which is based on HTML5/CSS3.

PINP also supports markdown blog writing, any slide page can embed into a blog. So, PINP blog is simple since markdown syntax is simple, on the other hand, it is powerful for embedding of slide page, see sample document.

How it works?

PINP blog system is depend on the features of github pages, in one word, when you create a public repository in github.com and set gh-pages as default branch, you can visit your static web files (such as html, css, js, etc) by URL https://<username>.github.io/<repository>/index.html, there is one thing important, github pages is free!

When static web files are organized as PINP DOC required, they would served as PINP blog and PINP slide. The blog homepage will list all published PINP documents, it come with online editor and offline editor also.

The homepage of PINP blog looks like this.

Build a free blog system in github

It sounds good, so, how to build one for myself? Please follow next 3 steps:

Step 1: Create github account

Ignore this step if you already have a github account. Goto homepage of github, click Sign up button and fill personal information as required.

Step 2: Fork PINP supports repository (i.e. pinp/software)

Open github repository: pinp/software, then click Fork button to clone it to your account. Then, select software/blogger10.json file and edit it, set the value of home_repository to blog, as following diagram.

The value "blog" is another repository which will be cloned at next step, it use for denoting which is root blog, then, click Commit changes button to apply the modification.

Warning: you should modify yourself's blogger10.json which is forked from pinp/software, i.e. modify the file in <username>/software/ folder, not the one in pinp/software/.

Step 3: Fork blog repository (i.e. pinp/blog)

Open github repository: pinp/blog, click Fork button to clone it to your account. Then, select blog/config.json file and edit it, set the value of user_name to your registed username, set the value of repos_name to blog, as following diagram (suppose your username is best-js).

Next, click Commit changes button to apply the modification.

Warning: you should modify yourself's config.json which is forked from pinp/blog, i.e. modify the file in <username>/blog/ folder, not the one in pinp/blog/.

Your blog system should be ready by now, please visit it by https://<username>.github.io/blog/ (you should replace <username> to your registed name).

Be involved in

Open your blog:

Click to open the blog which is related to current repository
Or, open URL: https://<username>.github.io/blog/
Or, go to your blog repository and click the link: view shared blogs

If you find any bug or have a suggestion, please raise an issue or a request in github.

Click one of following buttons if you want share this project with your friends:

More information

A set of "Online help" documents will be installed into your blog, include such things:

Online help, introduces how to edit blog online or offline, how to extend template system, etc
Todo list, progress plan
News and activity report

These content will be updated if necessary, you would be notified in your blog homepage when big things happen about this project.

License

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of PINP.ME nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

YLiJingan / software