PlainSite 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 313dfb3ffc12bf634379115f8bd397667e478045
+  data.tar.gz: 8819599394528bfe0c69fca6227ede91c9ab82f9
+SHA512:
+  metadata.gz: eb7f464d362f286bf3e4d4fd5937b3a1fc0f6211b7c41cbf85b925e2624dca44976a662def2cc53d3481bf0a1e8c9eb39df750e01769b04f1d0f516683c364d2
+  data.tar.gz: 5a85fae2d574b4ef272dfc6f050c95279f45a956a3ea09c1d4f4002a524192db0919bfa5694e9ed91d46be99d2b2937382eea875969f7ebdf02ec3bd79a47d9a

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    PlainSite (1.2.0)
+      commander (~> 4.4)
+      git (~> 1.5)
+      kramdown (~> 1.17)
+      listen (~> 3.1)
+      pygments.rb (~> 1.2)
+      rake (~> 12.3)
+      safe_yaml (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    commander (4.4.7)
+      highline (~> 2.0.0)
+    ffi (1.11.1-x64-mingw32)
+    git (1.5.0)
+    highline (2.0.2)
+    kramdown (1.17.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    multi_json (1.13.1)
+    pygments.rb (1.2.1)
+      multi_json (>= 1.0.0)
+    rake (12.3.2)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    ruby_dep (1.5.0)
+    safe_yaml (1.0.5)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  PlainSite!
+
+BUNDLED WITH
+   1.17.1

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 CJ
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/PlainSite.gemspec

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "PlainSite"
+
+Gem::Specification.new do |s|
+  s.name       = 'PlainSite'
+  s.version    = PlainSite::VERSION
+  s.license    = 'MIT'
+  s.date       = '2013-08-25'
+  s.author     = 'Jex'
+  s.email      = 'i@jex.im'
+  s.homepage   = 'https://github.com/CJex/PlainSite'
+  s.summary    = 'A Truely Hackable Static Site Generator.'
+  s.description  = 'PlainSite is a simple but powerful static site generator inspired by Jekyll and Octopress.'
+
+  s.files    = Dir['**/*'].reject { |f|
+    (File.directory? f) || (f.end_with? ".gem")
+  }
+
+  s.test_files   = s.files.select { |path| path =~ /^test\/.*_test\.rb/ }
+  s.require_path = 'lib'
+  s.bindir     = 'bin'
+  s.executables  = ['plainsite']
+
+  s.required_ruby_version = '>= 1.9.3'
+
+  [
+    'pygments.rb', '~> 1.2',
+    'kramdown', '~> 1.17',
+    'safe_yaml', '~> 1.0',
+    'git', '~> 1.5',
+    'rake', '~> 12.3',
+    'commander', '~> 4.4',
+    'listen', '~> 3.1'
+  ].each_slice(2) do |a|
+    s.add_runtime_dependency *a
+  end
+
+end

data/README.md

@@ -0,0 +1,276 @@
+PlainSite
+=========
+
+PlainSite：A Truely Hackable Static Site Generator.
+
+<strong style="font-size:larger; color:red;"> This project is no longer maintained! </strong>
+
+## Getting Started
+
+1. Install [Ruby](https://www.ruby-lang.org/) and then:
+```bash
+gem install PlainSite
+```
+
+2. Init site:
+```bash
+cd mysite
+plainsite init
+```
+
+3. Create new post:
+```bash
+plainsite newpost post-slug 'Hello,wolrd!This is the title!'
+```
+
+4. Preview site,open <http://localhost:1990/> in your web browser.
+```bash
+plainsite serve
+```
+
+5. Configure '_src/config.yml'
+```yaml
+url: http://example.com   # You site's domain or url prefix.
+disqus_id:                # Config to enable disqus comments.
+name: YouBlogName
+author: YouName
+```
+
+6. Build site static pages:
+```bash
+plainsite build
+```
+
+## Features
+1. Give you back full control of generating pages.
+2. Along with Git,PlainSite can generate only updated posts' corresponding pages.
+3. Builtin live reload preview web server.
+4. Generate relative url thus enable to view site through `file://` protocal without any web server.
+5. Auto clean deleted posts' corresponding pages.
+6. Pagination becomes incredibly easy.
+
+
+## Site Directory Structrue
+
+Run `plainsite init` will get things done.
+
+```
+.
+├── .git
+├── .nojekyll
+└── _src
+  ├── assets
+  ├── data
+  │   ├── category
+  │   ├── demo-post.html
+  │   └── 2012-12-25-hello-world.md
+  ├── templates
+  │   └── post.html
+  ├── routes.rb
+  └── config.yml
+```
+
+All files under `_src` directory are the source files.Here is each sub directory's usage:
+
+1. `assets`: Put all your static files in it for easier maintenance. PlainSite will copy them to site's root on building.For example, if you want to [add a CNAME file to enable custom domain](https://help.github.com/articles/adding-a-cname-file-to-your-repository/),you need to put it at `/_src/assets/CNAME`,so PlainSite will copy it to `/CNAME`.
+2. `data`: Put your post files here,each file corresponds to a `Post`,each directory corresponds to a `Category`.
+3. `templates`: ERB template files.
+4. `routes.rb`: All custom tricks: url pattern,pagination, etc...
+5. `config.yml`: Site configuration.
+
+
+## Command Usages
+1. Run `plainsite build --local` will use relative url in output pages.
+2. Run `plainsite build --all` will force generate all pages.
+1. Run `plainsite help` for more command line options.
+
+## Code Highlight
+Example post file content:
+```html
+---
+title: Hello,world!
+---
+
+**Here is post's content!**
+
+Ruby：
+<highlight ruby>
+puts "Hello,world!"
+</highlight>
+
+Python，with line numbers：
+<highlight python linenos>
+def hello():
+  print("Hello")
+</highlight>
+
+Specify the start line number:
+<highlight php linenos=20>
+echo "PlainSite";
+ob_flush();
+</highlight>
+
+If there is no line feed char in code, it will output an inline code element:<highlight>puts "Inline"</highlight>
+```
+
+## Customation
+
+
+### Concepts:
+
+1. Post：`PlainSite::Data::Post`
+
+   Plain text file under `_src/data/`,represents one post.
+
+2. Category：`PlainSite::Data::Category`
+
+   Directory under  `_src/data/`.
+
+3. Template
+
+   ERB template files Under `_src/templates/` directory.
+
+4. Routes
+
+   Ruby script at ```_src/routes.rb```.
+
+
+**PlainSite will ignore Post、Template files or Category directories which prefix with underscore.**
+
+
+### Post and Category
+
+Files under site's `_src/data/` directory represent Post：
+```
+_src/data/2011-02-28-hello-world.md
+```
+The `2011-02-28` is post's created date(optional);`hello-world` is post's slug(required).It's not allowed that two post files under the same category directory have the same slug;The `.md` ,viz. extname,represents Post's content type(PlainSite only support Markdown and HTML two content types,corresponding extnames are `md` and `html`.
+
+Post file content must starts with [YAML-Front format header](http://jekyllrb.com/docs/frontmatter/),and at least contains a `title` property.
+
+The Post file's path relative to `_src/data` represents its Category.You can use directory as category to organize posts.For example,here are two categories:`programming` and `essays`:
+```
+_src/data/programming/2011-02-28-hello-world.md
+_src/data/essays/2013-04-22-life-is-a-game.md
+```
+
+Category.data_id is the path relative to `_src/data`.
+
+Post.data_id equals `Post.category.data_id + "/" + Post.slug` .
+
+You can put an `_meta.yml` file under Category's directory to custom its attributes,such as `display_name`:
+Here is an example file at `_src/data/programming/_meta.yml`：
+```yaml
+display_name: ProgrammingLife
+```
+
+All properties specified in post's YAML header can be accessed via Post object directly.
+
+
+## Routes and Templates
+File `_src/routes.rb` is used to custom url pattern and all what you want.
+The `_src/routes.rb` file is just a Ruby script that loaded and executed by PlainSite.
+You can use global variable `$site` to access current `PlainSite::Site` instance object.
+Through `$site.data` to get site root category(`_src/data`),`PlainSite::Data::Category` instance object.
+For examples：
+
+```ruby
+# coding:utf-8
+
+$site.route(
+  # url_pattern specify the output page's urlpath（relative to site root）
+  url_pattern: 'index.html',
+
+  # template file path relative to `_src/templates/`
+  template: 'index.html',
+
+  # The 'data' will be sent to template to render.
+  # If data is Array/PostList object, It will render each item with template into seperated pages.
+  # ERB template's context is which 'data' property specified，
+  # ERB code can access its key or method directly,
+  # e.g. here 'index.html' template's erb code can directly use site and demo variables
+  data: {site: $site, demo:123},
+  build_anyway: true # Force build this route every time.
+)
+
+$site.route( # Generate single post page
+  url_pattern: 'about.html',
+  data: $site.data / :about , # Retrieve the Post which data_id is 'about'
+  template: 'post.html'
+)
+
+$site.route( # Generate posts under essays category
+  # ur_pattern: '{date.year}/{date.month}/{date.day}/{slug}.html',
+  url_pattern: '{data_id}.html', # url_pattern support variable replacement
+                                 # which is Post's property
+  data: 'essays/*', # Get all posts under 'essays',return PlainSite::Data::PostList instance
+  template: 'post.html'
+)
+
+$site.route(
+  url_pattern: 'programming/{slug}.html',
+  data: $site.data / :programming / :*, # synonym of 'programming/*'
+  template: 'post.html'
+)
+
+# $site.data.subs are categories under '_src/data',return Category[]
+$site.data.subs.each do |category|
+  $site.route(
+    url_pattern: "#{category.name}/{slug}.html",
+    # category.posts/5 means category.paginate(page_size:5),return PostListPage[]
+    data: category.posts/5 , # category.posts is same as 'category / :* '
+    template: 'list.html'
+  )
+end
+
+```
+
+
+Template system supports layout,specified in its YAML Header：
+```erb
+---
+layout: base.html   # file path relative to self
+---
+<% content_for :page_title do %>
+  <%=title%> - <%=site.name %>
+<% end %>
+<% content_for :page_content do %>
+  <h1><%=title%></h1>
+  <p>Date：<%=date%></p>
+  <%=content%>
+  <hr />
+
+  Use site.url_for to get url which affected by 'plainsite build --local' and resulted in relative url.
+  <%=site.url_for 'essays/hello' %>
+
+  Also support includes.
+  <%=include 'footer.html' %>
+<% end %>
+```
+
+The `base.html` contents：
+
+```erb
+<html>
+<head>
+  <title><%=yield :page_title%></title>
+</head>
+<body>
+  <%=yield :page_content%>
+</body>
+</html>
+```
+
+## More
+
+1. Run `gem server` to read PlainSite rdoc.
+2. Read the source code.
+
+## Sites using PlainSite
+
+<span style="font-size:larger">Jex's Blog: <a href="https://jex.im/">https://jex.im/</a></span>
+
+
+
+
+

data/Rakefile

@@ -0,0 +1,34 @@
+# coding:utf-8
+require 'rake'
+require 'rake/testtask'
+require 'rdoc'
+require 'PlainSite'
+
+task :default => [:list]
+
+desc 'List available tasks'
+task :list do
+  sh 'rake -T'
+end
+
+desc 'Run irb'
+task :irb do
+  sh 'irb -rubygems -I"lib:test"'
+end
+
+
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.pattern = 'test/*.rb'
+  test.verbose = true
+end
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "PlainSite v#{PlainSite::VERSION}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/_config.yml

@@ -0,0 +1,6 @@
+theme: jekyll-theme-cayman
+
+exclude:
+  - lib/PlainSite/_scaffold/
+  - test/fixtures/
+

data/bin/plainsite

@@ -0,0 +1,76 @@
+#!/usr/bin/env ruby
+# coding:utf-8
+file=File.realpath __FILE__
+BIN_FILE=File.basename(file)
+$:.unshift File.join(File.dirname(file), *%w{ .. lib })
+
+require 'commander/import'
+require 'PlainSite'
+require 'PlainSite/Commands'
+
+program :name, 'PlainSite'
+program :version, PlainSite::VERSION
+program :description, 'PlainSite - simple static site generator.'
+default_command :help
+
+global_option '-r','--root [DIR]', 'Site root directory (defaults to ./)'
+
+command :init do |c|
+  c.syntax = BIN_FILE+' init [options]'
+  c.summary = 'Init site scaffold.'
+  c.description = 'Init site scaffold,create a _site directory structure and place some examples.'
+  c.example 'Init new site /tmp/site1', 'init -r /tmp/site1'
+  c.option '--override', 'Override existing files (defaults to false)'
+  c.action do |args, options|
+    PlainSite::Commands.run :init,args,options
+  end
+end
+
+
+command :build do |c|
+  c.syntax = BIN_FILE+' build [options] [includes]'
+  c.summary = 'Generate static pages.'
+  c.description = 'Generate html pages.
+Default it will read git status and only generate updated posts and templates\' corresponding pages.
+If you want to generate specified files.Pass posts or templates file path as includes arguments.'
+  c.option '-d', '--dest [DIR]', 'Destination directory (defaults same as root)'
+  c.option '-a', '--all', 'Force regenerate all pages (default is false,only generate updated pages)'
+  c.option '-l','--local', 'Generate relative url.So you can view you site without web server.'
+  c.action do |args, options|
+    PlainSite::Commands.run :build,args,options
+  end
+end
+
+command :serve do |c|
+  c.syntax = BIN_FILE+' serve [options]'
+  c.summary = 'Run a preview web server.'
+  c.description = 'Run a preview web server on specified host and port'
+  c.option '--host [HOST]', 'Server host,defaults to 127.0.0.1'
+  c.option '-p', '--port [PORT]', 'Server port,default is 1990'
+  c.action do |args, options|
+    PlainSite::Commands.run :serve,args,options
+  end
+end
+
+command :newpost do |c|
+  c.syntax = BIN_FILE+' newpost [data_id] [title]'
+  c.summary = 'Create new post.'
+  c.description = <<DESC
+The data_id is post's category/slug,created post file's date is today's date,if extension name not specified,default is '.md'.
+DESC
+
+  c.example "Create new post file '_site/essay/life-is-a-game.md'", 'newpost essay/life-is-a-game'
+
+  c.action do |args, options|
+    PlainSite::Commands.run :newpost,args,options
+  end
+end
+
+command :clean do |c|
+  c.syntax = BIN_FILE+' clean'
+  c.summary = 'Clean isolated files.'
+  c.description = 'This command is danger.It will delete isolated files that neither copied from `_src/assets/` nor generated by `_src/routes.rb`.You must put all static site files under `_src/assets/`.'
+  c.action do |args, options|
+    PlainSite::Commands.run :clean,args,options
+  end
+end