documentation

styling main ttbp info page, which now also references the readme.MD
file and has a snazzier live feed view.
master
endorphant 2016-05-20 00:32:50 -04:00
parent cd63c6f09a
commit 82172e4a29
3 changed files with 53 additions and 9 deletions

View File

@ -34,7 +34,8 @@ header and footer files. the program sets you up with basic
default. if you break your page somehow, you can force the program to default. if you break your page somehow, you can force the program to
regenerate your configuration by deleting your ~/.ttbp directory entirely. **you might want to back up your ~/.ttbp/entries directory before you do this.** regenerate your configuration by deleting your ~/.ttbp directory entirely. **you might want to back up your ~/.ttbp/entries directory before you do this.**
* to modify your stylesheet, edit your ~/.ttbp/www/style.css * to modify your stylesheet, edit your ~/.ttbp/config/style.css
* (future feature: having multiple stylesheets you can select)
* to modify the page header, edit your ~/.ttbp/config/header.txt * to modify the page header, edit your ~/.ttbp/config/header.txt
* you might note that there's a place marked off in the default header where you can safely put custom HTML elements! * you might note that there's a place marked off in the default header where you can safely put custom HTML elements!
* to modify the page footer, edit your ~/.ttbp/config/footer.txt * to modify the page footer, edit your ~/.ttbp/config/footer.txt

View File

@ -17,6 +17,7 @@ WWW = os.path.join(PATH, "www")
CONFIG = os.path.join(PATH, "config") CONFIG = os.path.join(PATH, "config")
DATA = os.path.join(PATH, "entries") DATA = os.path.join(PATH, "entries")
FEED = os.path.join(SOURCE, "www", "index.html") FEED = os.path.join(SOURCE, "www", "index.html")
DOCS = os.path.join(SOURCE, "www", "help.html")
NOPUB = os.path.join(CONFIG, "nopub") NOPUB = os.path.join(CONFIG, "nopub")
HEADER = "" HEADER = ""
@ -200,22 +201,31 @@ def write_global_feed(blogList):
<link rel=\"stylesheet\" href=\"style.css\" /> <link rel=\"stylesheet\" href=\"style.css\" />
</head> </head>
<body> <body>
<div class="meta">
<h1>tilde.town feels engine</h1> <h1>tilde.town feels engine</h1>
<h2><a href="https://github.com/modgethanc/ttbp">github <h2><a href="https://github.com/modgethanc/ttbp">github
repo</a> | <a repo</a> | <a
href="http://tilde.town/~endorphant/blog/20160510.html">state href="http://tilde.town/~endorphant/blog/20160510.html">state
of the ttbp</a></h2> <div class="box"> of the ttbp</a></h2>
<p>curious? run <b>~endorphant/bin/ttbp</b> while logged in to tilde.town.</p> <!--<p>curious? run <b>~endorphant/bin/ttbp</b> while logged in to tilde.town.</p>
<p>it's still a little volatile. let me know if anything breaks.</p> <p>it's still a little volatile. let me know if anything breaks.</p>---></div>
<p>&nbsp;</p> <p>&nbsp;</p>
<h3>live feels-sharing:</h3>
<div class=\"feed\">
<ul>
""") """)
## docs
outfile.write("""\
<div class="docs">""")
outfile.write(mistune.markdown(open(os.path.join(SOURCE, "..", "README.md"), "r").read()))
outfile.write("""\
</div>""")
## feed ## feed
outfile.write("""\
<p>&nbsp;</p>
<div class=\"feed\">
<h3>live feels-sharing:</h3>
<ul>""")
for blog in blogList: for blog in blogList:
outfile.write(""" outfile.write("""
<li>"""+blog+"""</li>\ <li>"""+blog+"""</li>\
@ -231,7 +241,32 @@ def write_global_feed(blogList):
outfile.close() outfile.close()
def make_docs():
outfile = open(DOCS, "w")
outfile.write("""\
<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 3.2//EN\">
<html>
<head>
<title>tilde.town feels engine</title>
<link rel=\"stylesheet\" href=\"style.css\" />
</head>
<body>
<h1>tilde.town feels engine</h1>
<h2><a href="https://github.com/modgethanc/ttbp">github
repo</a> | <a
href="http://tilde.town/~endorphant/blog/20160510.html">state
of the ttbp</a></h2> <div class="box">""")
outfile.write(mistune.markdown(open(os.path.join(SOURCE, "..", "README.md"), "r").read()))
outfile.write("""
</div>
</body>
</html>
""")
outfile.close()
############# #############
############# #############
############# #############

View File

@ -4,7 +4,6 @@ TO-DO:
-command line flags: -command line flags:
-shortcut to most recent feels, writing entry, seeing own entry -shortcut to most recent feels, writing entry, seeing own entry
-neighbor view takes you to individual entry listing -neighbor view takes you to individual entry listing
-make ttbp/index.html reference readme.md
(goals for version two) (goals for version two)
@ -21,6 +20,15 @@ TO-DO:
CHANGELOG: CHANGELOG:
ver 0.8.6; mostly structural changes
-a freaking patch utility?! yes, there's a patch utility now
-settings now has an option to publish or not publish your blog to
public_html
-changing your publish directory actually moves files correctly
-html files are now stored at .ttbp/www, and the public_html path just
symlinks there
-style.css now lives in .ttbp/config, and is symlinked from www
ver 0.8.5 ver 0.8.5
-publish feels directory to ~endorphant/ttbp/index.html -publish feels directory to ~endorphant/ttbp/index.html
-(beta only) colorized menus -(beta only) colorized menus