scratch/README.md

61 lines
2.3 KiB
Markdown
Raw Normal View History

2011-09-13 11:26:44 +00:00
# yannesposito.com
2012-06-04 19:52:14 +00:00
This is the source code for the [yannesposito.com](yannesposito.com) website.
2011-09-13 11:26:44 +00:00
It is mainly a multi-language blog based on [nanoc](nanoc.stoneship.org).
_Notice, this is not a clean system.
2012-06-04 19:51:33 +00:00
Mainly because I have used it for some years now.
2011-09-13 11:26:44 +00:00
I just want it to work, not to be a nice piece of code.
But in the end I know I will make it clean._
What you'll need to use it:
- [nanoc](nanoc.stoneship.org) → `gem install nanoc`
2012-06-04 19:51:33 +00:00
- [zsh](zsh.org) → Installed by default on most good system
2011-09-13 11:26:44 +00:00
- A bunch of gems: `gem install ultraviolet krambook sass rainpress`
Optionally
- [graphviz](graphviz.org)
2012-06-04 19:51:33 +00:00
Here is a short explanation of the role of each file:
2011-09-13 11:26:44 +00:00
config.rb → nanoc central configuration file
config.ru → Rack server configuration
config.yaml → A YAML configuration file (mostly strings)
2012-06-04 19:51:33 +00:00
content/ → The directory where nanoc will search for most of the content
2011-09-13 11:26:44 +00:00
img_latest_blog_dir@ → A link to the latest blog image directory
latest.md@ → A link to the latest blog file
layouts/ → HTML Layouts for your webpages
lib/ → Some ruby files loaded by nanoc before generating
multi/ → Where you should write content
output/ → Where the content is loaded
Rakefile → Ruby actions
README.md → This file
2012-06-04 19:51:33 +00:00
resources/ → Some files I used and wanted to keep
2011-09-13 11:26:44 +00:00
Rules → Generation rules
2012-06-04 19:51:33 +00:00
tasks/ → Where I put most of my scripts
2011-09-13 11:26:44 +00:00
Here are features I added:
analytics.rb → Functions to add web analytics code
2012-06-04 19:51:33 +00:00
calendar.rb → Functions to show a date nicely in HTML
2011-09-14 07:51:52 +00:00
gitmtime.rb → Show time using git last change log
graph.rb → Use graphviz to draw graphs
helpers.rb → Some standard nanoc helpers are added
html.rb → Layout block helper
intenseDebate.rb → IntenseDebate integration
macros.rb → Macros system (%latex => LaTeX, etc...)
mail.rb → My uniquely encoded personal email
multiMenu.rb → The machinery for the menu
multi.rb → The machinery for helping to be multi-language
2011-09-13 11:26:44 +00:00
nanoc_item_conf.rb
repair_html.rb
syntaxColorize.rb
tag.rb
ultraviolet.rb
y.rb