Skip to content

Commit

Permalink
How to learn Emacs.
Browse files Browse the repository at this point in the history
  • Loading branch information
drothlis committed Apr 8, 2012
0 parents commit 27bfdca
Show file tree
Hide file tree
Showing 53 changed files with 5,770 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
layout.html
.DS_Store
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "haml"]
path = haml
url = git://github.com/drothlis/haml.git
12 changes: 12 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Copyright © 2012 David Röthlisberger.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is available at http://www.gnu.org/copyleft/fdl.html

The scripts in the bin/ directory, and the makefile in the same directory as
this LICENSE file, are released to the public domain. If you live somewhere
with totally braindead Copyright laws, you can use them (the scripts and the
makefile) under the ISC or CC0 licenses, both of which are as close to the
public domain as possible.
60 changes: 60 additions & 0 deletions README
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
"How to learn Emacs" <http://david.rothlis.net/emacs/howtolearn.html>
is a guide aimed at computer programmers who want to master the GNU Emacs
text editor.


Generating HTML from the source HAML files
==========================================

The document source is in Haml + Markdown format: Haml for HTML block
structure, and Markdown for paragraphs and formatting.

Haml uses significant indentation:

HAML HTML
#about <div id='about'>
*Hello* there *Hello* there
</div>

See <http://haml-lang.com> for details.

I use a custom fork† of Haml that automatically formats plain-text content
through Markdown‡, so the above Haml example actually converts to:

<div id='about'>
<p>
<em>Hello</em> there
</p>
</div>

† <https://github.com/drothlis/haml/wiki>
‡ <http://daringfireball.net/projects/markdown/syntax>

To install all the necessary tools: (on a Unixy system: Linux, OS X, etc.)

1. Install ruby and rubygems (the ruby package manager) with your system's
package manager (macports or homebrew on OS X, apt-get or yum on some Linux
distributions, etc.). You may already have these installed (try `ruby` and
`gem` at the terminal). On some systems the `rubygems` package is called
`rb-rubygems`.

2. Use `gem` to install the rdiscount package (a Markdown implementation):
`gem install rdiscount`

3. Clone this repository:
`git clone git://github.com/drothlis/how-to-learn-emacs.git`

4. Fetch the haml submodule of this repository:
`cd how-to-learn-emacs`
`git submodule init`
`git submodule update`

5. Build the HTML from the Haml sources:
`make`


Why are the generated HTML files tracked in the git repository?
===============================================================

So that I can easily see the effects of changes to the scripts that generate
the HTML.
Loading

0 comments on commit 27bfdca

Please sign in to comment.