Skip to content

matael/markdown-static-sites

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Markdown Static Sites

[Flattr this git repo](https://flattr.com/submit/auto?user_id=Matael&url=https://github.com/Matael/markdown-static-sites&title=Markdown Static Sites&language=en_GB&tags=github&category=software)

Why

I've created this tool 'cause one day, I needed a really simple tool to create static sites without using HTML for the whole creation.

I based the developement on c9s' markdown-git-wiki that I had already forked.

How

This tool use the original Markdown.pl script from daringfireball.

Look at the Makefile for further details.

To turn markdown files into html files, just use :

$ make pages

You can add media (pictures, lolcats, etc...) in the media/ directory (you have to create it) To copy all the media (CSS files + media/) into the pages directory, you can use :

$ make media

To do all as one :

$ make

or

$ make all

On Windows

I've also try to implement the same targets that in makefile using batch scripts (argh...). To use this tools, just copy the content of win_tools folder to the directory's root.

Instead of make use the following commands :

  • make pages => pages.cmd
  • make media => media.cmd
  • make clean => clean.cmd

Served by a webserver

A simple web server could serve your website (which is located under the pages directory).

Apache example

Here is an example of an Apache vHost serving the website (website location : /home/me/website/) :

<VirtualHost *:80>
    ServerName example.com
    ServerAdmin admin@example.com
    DocumentRoot /home/me/website
    <Directory /home/me/website>
        Options Indexes FollowSymLinks MultiViews
        AllowOverride None
        Order allow,deny
        allow from all
    </Directory>
</VirtualHost>

About

A simple way to create markdown static sites using markdown

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published