Skip to content

Commit

Permalink
Add generator specific files and helpers, set defaults
Browse files Browse the repository at this point in the history
Ignore temporary and generated files.
Document useful commands in the README.
  • Loading branch information
carstene1ns committed Sep 13, 2015
1 parent 513ba7c commit 77362f9
Show file tree
Hide file tree
Showing 8 changed files with 248 additions and 2 deletions.
10 changes: 10 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@

# nanoc
/tmp/
/output/
/crash.log

# bundler
/bin/
/vendor/
/.bundle/
8 changes: 8 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@

source 'https://rubygems.org'

gem 'nanoc', github: 'nanoc/nanoc', branch: 'release-4.0.x'
gem 'guard-nanoc', github: 'guard/guard-nanoc'
gem 'adsf'
gem 'kramdown'
gem 'nokogiri'
75 changes: 75 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
GIT
remote: git://github.com/guard/guard-nanoc.git
revision: 7a44c90333a4077c63a710bbf36216299929d27d
specs:
guard-nanoc (2.0.0b1)
guard (~> 2.8)
guard-compat (~> 1.0)
nanoc (~> 4.0.0b4)

GIT
remote: git://github.com/nanoc/nanoc.git
revision: 1191fedfe0b775553082e24acb17358747023d6d
branch: release-4.0.x
specs:
nanoc (4.0.0rc2)
cri (~> 2.3)

GEM
remote: https://rubygems.org/
specs:
adsf (1.2.0)
rack (>= 1.0.0)
coderay (1.1.0)
colored (1.2)
cri (2.7.0)
colored (~> 1.2)
ffi (1.9.10)
formatador (0.2.5)
guard (2.13.0)
formatador (>= 0.2.4)
listen (>= 2.7, <= 4.0)
lumberjack (~> 1.0)
nenv (~> 0.1)
notiffany (~> 0.0)
pry (>= 0.9.12)
shellany (~> 0.0)
thor (>= 0.18.1)
guard-compat (1.2.1)
kramdown (1.8.0)
listen (3.0.3)
rb-fsevent (>= 0.9.3)
rb-inotify (>= 0.9)
lumberjack (1.0.9)
method_source (0.8.2)
mini_portile (0.6.2)
nenv (0.2.0)
nokogiri (1.6.6.2)
mini_portile (~> 0.6.0)
notiffany (0.0.7)
nenv (~> 0.1)
shellany (~> 0.0)
pry (0.10.1)
coderay (~> 1.1.0)
method_source (~> 0.8.1)
slop (~> 3.4)
rack (1.6.4)
rb-fsevent (0.9.6)
rb-inotify (0.9.5)
ffi (>= 0.5.0)
shellany (0.0.1)
slop (3.6.0)
thor (0.19.1)

PLATFORMS
ruby

DEPENDENCIES
adsf
guard-nanoc!
kramdown
nanoc!
nokogiri

BUNDLED WITH
1.10.6
8 changes: 8 additions & 0 deletions Guardfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Guardfile
# More info at https://github.com/guard/guard#readme

guard 'nanoc' do
watch('nanoc.yaml')
watch('Rules')
watch(%r{^(content|layouts|lib)/.*$})
end
30 changes: 28 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,28 @@
# easyrpg-website
Source code of the EasyRPG homepage https://easy-rpg-org
# easy-rpg.org

Source code of the EasyRPG homepage https://easy-rpg.org

## Make initial gem bundle:

bundle install --binstubs --path=vendor/bundle [--shebang="ruby1.9"]

## Build page:

nanoc

## Start local server (needs adsf):

nanoc view

Visit the site at http://localhost:3000/ locally. Use `CTRL` + `C` to stop the
server.

## Setup automatic rebuild (already done if `Guardfile` exists):

guard init nanoc

## Start automatic rebuild

guard

Use `exit` to end the guard shell.
27 changes: 27 additions & 0 deletions Rules
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
#!/usr/bin/env ruby

compile '/**/*.html' do
layout '/default.*'
end

compile '/**/*.md' do
filter :kramdown
layout '/default.*'
end

compile '/**/*' do
end

route '/**/*.{html,md}' do
if item.identifier =~ '/index.*'
'/index.html'
else
item.identifier.without_ext + '/index.html'
end
end

route '/**/*' do
item.identifier.to_s
end

layout '/**/*', :erb
9 changes: 9 additions & 0 deletions helper.bash
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
#!/bin/bash

DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
export PATH=$DIR/bin:$PATH
return 2>/dev/null

echo "Use the Source, Luke."
echo ""
echo "$ source path/to/helper.bash"
83 changes: 83 additions & 0 deletions nanoc.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# The syntax to use for patterns in the Rules file. Can be either `"glob"`
# (default) or `"legacy"`. The former will enable glob patterns, which behave
# like Ruby’s File.fnmatch. The latter will enable Nanoc 3.x-style patterns.
string_pattern_type: glob

# A list of file extensions that Nanoc will consider to be textual rather than
# binary. If an item with an extension not in this list is found, the file
# will be considered as binary.
text_extensions: [ 'coffee', 'css', 'erb', 'haml', 'handlebars', 'hb', 'htm', 'html', 'js', 'less', 'markdown', 'md', 'ms', 'mustache', 'php', 'rb', 'rdoc', 'sass', 'scss', 'slim', 'txt', 'xhtml', 'xml' ]

# The path to the directory where all generated files will be written to. This
# can be an absolute path starting with a slash, but it can also be path
# relative to the site directory.
output_dir: output

# A list of index filenames, i.e. names of files that will be served by a web
# server when a directory is requested. Usually, index files are named
# “index.html”, but depending on the web server, this may be something else,
# such as “default.htm”. This list is used by Nanoc to generate pretty URLs.
index_filenames: [ 'index.html' ]

# Whether or not to generate a diff of the compiled content when compiling a
# site. The diff will contain the differences between the compiled content
# before and after the last site compilation.
enable_output_diff: false

prune:
# Whether to automatically remove files not managed by Nanoc from the output
# directory.
auto_prune: true

# Which files and directories you want to exclude from pruning. If you version
# your output directory, you should probably exclude VCS directories such as
# .git, .svn etc.
exclude: [ '.git' ]

# The data sources where Nanoc loads its data from. This is an array of
# hashes; each array element represents a single data source. By default,
# there is only a single data source that reads data from the “content/” and
# “layout/” directories in the site directory.
data_sources:
-
# The type is the identifier of the data source.
type: filesystem

# The path where items should be mounted (comparable to mount points in
# Unix-like systems). This is “/” by default, meaning that items will have
# “/” prefixed to their identifiers. If the items root were “/en/”
# instead, an item at content/about.html would have an identifier of
# “/en/about/” instead of just “/about/”.
items_root: /

# The path where layouts should be mounted. The layouts root behaves the
# same as the items root, but applies to layouts rather than items.
layouts_root: /

# The encoding to use for input files. If your input files are not in
# UTF-8 (which they should be!), change this.
encoding: utf-8

# The kind of identifier to use for items and layouts. The default is
# “full”, meaning that identifiers include file extensions. This can also
# be “legacy”, primarily used by older Nanoc sites.
identifier_type: full

# Configuration for the “check” command, which run unit tests on the site.
checks:
# Configuration for the “internal_links” checker, which checks whether all
# internal links are valid.
internal_links:
# A list of patterns, specified as regular expressions, to exclude from the check.
# If an internal link matches this pattern, the validity check will be skipped.
# E.g.:
# exclude: ['^/server_status']
exclude: [ '^blog/', '^forums/', '^wiki/', '^downloads/' ]

deploy:
public:
kind: rsync
dst: "[email protected]:~/public_html"
staging:
kind: rsync
dst: "uberspace:domains/test.f4ke.de"

0 comments on commit 77362f9

Please sign in to comment.