From 82172e4a29370e6308a9ef6fa97374094c5d5c09 Mon Sep 17 00:00:00 2001 From: endorphant Date: Fri, 20 May 2016 00:32:50 -0400 Subject: [PATCH] documentation styling main ttbp info page, which now also references the readme.MD file and has a snazzier live feed view. --- README.md | 3 ++- bin/core.py | 49 ++++++++++++++++++++++++++++++++++++++++++------- changelog.txt | 10 +++++++++- 3 files changed, 53 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 3b36a04..7a0d6c3 100644 --- a/README.md +++ b/README.md @@ -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 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 * 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 diff --git a/bin/core.py b/bin/core.py index 9079b44..654b9ec 100644 --- a/bin/core.py +++ b/bin/core.py @@ -17,6 +17,7 @@ WWW = os.path.join(PATH, "www") CONFIG = os.path.join(PATH, "config") DATA = os.path.join(PATH, "entries") FEED = os.path.join(SOURCE, "www", "index.html") +DOCS = os.path.join(SOURCE, "www", "help.html") NOPUB = os.path.join(CONFIG, "nopub") HEADER = "" @@ -200,22 +201,31 @@ def write_global_feed(blogList): +

tilde.town feels engine

github repo | state - of the ttbp

-

curious? run ~endorphant/bin/ttbp while logged in to tilde.town.

-

it's still a little volatile. let me know if anything breaks.

+ of the ttbp +

 

- -

live feels-sharing:

-
-
    """) + ## docs + outfile.write("""\ +
    """) + outfile.write(mistune.markdown(open(os.path.join(SOURCE, "..", "README.md"), "r").read())) + outfile.write("""\ +
    """) + ## feed + outfile.write("""\ +

     

    +
    +

    live feels-sharing:

    +
      """) for blog in blogList: outfile.write("""
    • """+blog+"""
      • \ @@ -231,7 +241,32 @@ def write_global_feed(blogList): outfile.close() +def make_docs(): + outfile = open(DOCS, "w") + + outfile.write("""\ + + + + tilde.town feels engine + + + +

      tilde.town feels engine

      + +

      github + repo | state + of the ttbp

      """) + + outfile.write(mistune.markdown(open(os.path.join(SOURCE, "..", "README.md"), "r").read())) + outfile.write(""" +
      + + +""") + outfile.close() ############# ############# ############# diff --git a/changelog.txt b/changelog.txt index 492a5a4..5deb893 100644 --- a/changelog.txt +++ b/changelog.txt @@ -4,7 +4,6 @@ TO-DO: -command line flags: -shortcut to most recent feels, writing entry, seeing own entry -neighbor view takes you to individual entry listing - -make ttbp/index.html reference readme.md (goals for version two) @@ -21,6 +20,15 @@ TO-DO: 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 -publish feels directory to ~endorphant/ttbp/index.html -(beta only) colorized menus