| author |
Mattijs Hoitink <mattijs@monkeyandmachine.com> |
| date |
Mon, 06 Feb 2012 15:59:43 +0100 |
| parents |
ee62f412c6ef |
| children |
b3fb6bc34867 |
import sys, os, shutil
import markdown
from pyquery import PyQuery as pq
j = os.path.join
md = markdown.Markdown(extensions=['toc', 'codehilite'])
up = lambda p: j(*os.path.split(p)[:-1])
dirname = lambda p: os.path.basename(os.path.abspath(p))
SOURCE_LOC = '.'
BUILD_LOC = './build'
INDEX_PRE = '''\
<!DOCTYPE html>
<html>
<head>
<title>{title_tag}</title>
<link rel="stylesheet" href="./_dmedia/bootstrap.css"/>
<link rel="stylesheet" href="./_dmedia/tango.css"/>
<link rel="stylesheet/less" type="text/css" href="./_dmedia/style.less">
<script src="./_dmedia/less.js" type="text/javascript">
</script>
</head>
<body class="index">
<div class="wrap">
<header><h1><a href="">{project_title}</a></h1></header>
<div class="markdown">
'''
CONTENT_PRE = '''\
<!DOCTYPE html>
<html>
<head>
<title>{title_tag}</title>
<link rel="stylesheet" href="../_dmedia/bootstrap.css"/>
<link rel="stylesheet" href="../_dmedia/tango.css"/>
<link rel="stylesheet/less" type="text/css" href="../_dmedia/style.less">
<script src="../_dmedia/less.js" type="text/javascript">
</script>
</head>
<body class="content">
<div class="wrap">
<header><h1><a href="..">{project_title}</a></h1></header>
<div class="markdown">
'''
POST = '''
</div>
<footer>{footer}</footer>
</div>
</body>
</html>
'''
def _get_target_url(path):
return os.path.split(_get_target(path))[-1]
def _get_target(path):
parts = path.split('-', 1)
if len(parts) > 1 and all(c in '0123456789' for c in parts[0]):
target = parts[1]
else:
target = path
return j(BUILD_LOC, target.rsplit(SOURCE_LOC, 1)[0])
def _get_project_title():
if os.path.isfile('title'):
with open('title') as f:
return f.read().strip()
else:
current = dirname(SOURCE_LOC).lower()
if current not in ['doc', 'docs', 'documentation']:
return current
else:
return dirname(j(SOURCE_LOC, '..')).lower()
def _find_chapters():
for filename in os.listdir(SOURCE_LOC):
name, ext = os.path.splitext(filename)
if ext in ['.markdown', '.md', '.mdown']:
if name not in ['footer', 'index']:
yield filename
def _get_footer():
if os.path.isfile('./footer.markdown'):
with open('./footer.markdown') as f:
return md.convert(f.read())
elif os.path.isfile('./footer.mdown'):
with open('./footer.mdown') as f:
return md.convert(f.read())
elif os.path.isfile('./footer.md'):
with open('./footer.md') as f:
return md.convert(f.read())
else:
return ''
def _get_toc(chapters):
toc = '<h2>Table of Contents</h2>'
toc += '<ol class="toc">'
for filename, title in chapters:
toc += '<li><a href="%s/">%s</a></li>' % (_get_target_url(filename), title)
toc += '</ol>'
return toc
def _fix_md_toc(content):
"""Remove the first heading level from the Markdown-generated TOC.
Only do so if it's on its own, though.
"""
e = pq(content)
if not e('.toc'):
return content
lis = e('.toc > ul > li')
if len(lis) > 1:
return content
subtoc = e('.toc > ul > li > ul').html()
e('.toc > ul').html(subtoc)
return unicode(e)
def _linkify_title(content, fallback_title):
e = pq(content)
title = e('.markdown h1').text()
if title:
e('.markdown h1').html('<a href="">' + title + '</a>')
else:
e('.markdown').prepend('<h1><a href="">' + fallback_title + '</a></h1>')
return unicode(e)
def _ensure_dir(path):
if not os.path.isdir(path):
os.makedirs(path)
def _get_fallback_title(path):
title = path.split(SOURCE_LOC, 1)[0]
if '-' in title and all([c in '0123456789' for c in title.split('-', 1)[0]]):
title = title.split('-', 1)[1]
title = title.replace('-', ' ').replace('_', ' ')
if title.lower() == title:
title = title.capitalize()
return title
def _find_title(content):
# TODO: Make this less ugly.
lines = content.splitlines()
if len(lines) == 0:
return None
first_line = lines[0].strip()
if first_line.startswith('#'):
return first_line.lstrip('#')
if len(lines) == 1:
return None
second_line = lines[1].strip()
if second_line and all(c == '=' for c in second_line):
return first_line
return None
def _render(title, footer, path, target, page_type, toc=None):
if page_type == 'index':
pre, post = INDEX_PRE, POST
else:
pre, post = CONTENT_PRE, POST
with open(path) as f:
data = f.read()
fallback_title = _get_fallback_title(path)
if page_type == 'content':
page_title = _find_title(data) or fallback_title
title_tag = page_title + ' / ' + title
else:
page_title = title_tag = title
content = pre.format(title_tag=title_tag, project_title=title)
content += md.convert(data)
content += toc or ''
content += post.format(footer=footer)
if page_type == 'content':
content = _linkify_title(_fix_md_toc(content), fallback_title)
if not os.path.isdir(target):
os.makedirs(target)
with open(j(target, 'index.html'), 'w') as f:
f.write(content)
return page_title
def render_chapter(title, footer, path):
target = _get_target(path)
return _render(title, footer, path, target, 'content')
def render_index(title, footer, chapters):
if os.path.isfile('index.markdown'):
path = 'index.markdown'
elif os.path.isfile('index.mdown'):
path = 'index.mdown'
elif os.path.isfile('index.md'):
path = 'index.md'
else:
return
target = BUILD_LOC
toc = _get_toc(chapters)
return _render(title, footer, path, target, 'index', toc)
def render_files(source, destination):
SOURCE_LOC = source
BUILD_LOC = destination
_ensure_dir(BUILD_LOC)
_ensure_dir(j(BUILD_LOC, '_dmedia'))
title = _get_project_title()
footer = _get_footer()
resources = j(up(__file__), 'resources')
for filename in os.listdir(j(up(__file__), 'resources')):
shutil.copyfile(j(resources, filename), j(destination, '_dmedia', filename))
chapters = []
for filename in _find_chapters():
chapter_title = render_chapter(title, footer, filename)
chapters.append((filename, chapter_title))
render_index(title, footer, chapters)