Permalink
Browse files

Document markdown support

  • Loading branch information...
1 parent b4c0149 commit 51298d8c5a69dc1c8fb24d8825d88237261eb439 @felixge committed Oct 24, 2012
Showing with 21 additions and 4 deletions.
  1. +17 −1 README.md
  2. +0 −3 example/pages/foo.md
  3. +4 −0 example/pages/markdown-rocks.md
View
@@ -15,14 +15,14 @@ Romulus is a static site generator (like jekyll) featuring:
* a clear folder convention
* ejs template processing
* generating css from less files
+* github flavored markdown
* a local development server behaving like github pages
**Planned:**
* `romulus deploy` for github pages deployment
* page scripts that run before rendering
* partials that can be included on any page
-* github flavored markdown
* plugins (themes, blogging, google analytics, disqus, etc.)
You should use romulus if you want a simple tool for creating static github
@@ -120,6 +120,22 @@ Sweet, your headline is now featuring my favorite color!
Any file placed in the `public` folder will be included at the top level of the
build output folder. The local development server also supports serving them.
+## Using markdown
+
+romulus natively supports
+[github flavored markdown](https://github.com/isaacs/github-flavored-markdown)
+for page files. Using markdown is as easy as creating a file called a file with
+a `.md` extension: `pages/markdown-rocks.md` and adding some markdown to it:
+
+```html
+<% this.layout = 'default'; %>
+
+Markdown is **fun**, and you can still use EJS inside of your markdown
+templates.
+```
+
+This page now will be served at `/markdown-rocks`.
+
## Page scripts
```
View
@@ -1,3 +0,0 @@
-<% this.layout = 'default'; %>
-
-Markdown is **fun**!
@@ -0,0 +1,4 @@
+<% this.layout = 'default'; %>
+
+Markdown is **fun**, and you can still use EJS inside of your markdown
+templates.

0 comments on commit 51298d8

Please sign in to comment.