update ttbp page
This commit is contained in:
parent
ca7e4290d2
commit
d54e3d4f7b
|
|
@ -1,22 +1,20 @@
|
||||||
---
|
---
|
||||||
author: ~ben
|
author: ~ben
|
||||||
published: true
|
published: true
|
||||||
title: tilde.team blogging platform
|
title: feels - tilde.team blogging platform
|
||||||
description: a cli blogging platform that can publish to your tilde page and your gopherhol
|
description: a cli blogging platform that can publish to your tilde page and your gopherhole
|
||||||
category:
|
category:
|
||||||
- main
|
- main
|
||||||
---
|
---
|
||||||
|
|
||||||
*a command-line based blogging platform running on tilde.team*
|
# FEELS MANUAL
|
||||||
|
|
||||||
`ttbp` stands for "tilde.town blogging platform", the original working name for
|
`ttbp` stands for "tilde.team blogging platform", the original working name for
|
||||||
this project.
|
this project. the complete codebase is available on
|
||||||
|
[tildegit](https://tildegit.org/team/ttbp).
|
||||||
|
|
||||||
|
`ttbp` was originally written for [tilde.town](https://tilde.town/~endorphant/ttbp/)
|
||||||
|
with sources available on [github](https://github.com/modgethanc/ttbp).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
`ttbp` runs from the command line, providing a hub for writing personal blog
|
`ttbp` runs from the command line, providing a hub for writing personal blog
|
||||||
posts and reading posts written by other users of tilde.team. it's a little bit
|
posts and reading posts written by other users of tilde.team. it's a little bit
|
||||||
|
|
@ -24,36 +22,21 @@ like livejournal or dreamwidth or tumblr. you can opt to publish your posts to a
|
||||||
public html file hosted on your tilde page, to tilde.team's gopher server, or
|
public html file hosted on your tilde page, to tilde.team's gopher server, or
|
||||||
keep all your entries private to the tilde.team server.
|
keep all your entries private to the tilde.team server.
|
||||||
|
|
||||||
to use, run `feels` while logged in to tilde.team
|
|
||||||
|
|
||||||
this is a project that runs on tilde.team, so all users of this program are
|
this is a project that runs on tilde.team, so all users of this program are
|
||||||
expected to operate under the tilde.team [code of
|
expected to operate under the tilde.team [code of
|
||||||
conduct](http://tilde.team/wiki/code-of-conduct). content/personal issues should be
|
conduct](http://tilde.team/wiki/code-of-conduct). content/personal issues should be
|
||||||
worked out according to the CoC, with support from the [administrative
|
worked out according to the CoC, with support from the [administrative
|
||||||
team](http://tilde.team/wiki/administration) if needed.
|
team](https://tilde.team/wiki/code-of-conduct#9--contact-info) if needed.
|
||||||
|
|
||||||
|
|
||||||
### QUICK START
|
|
||||||
|
|
||||||
no coding or html experience is necessary to get started. just log in to your
|
|
||||||
tilde.team account and enter:
|
|
||||||
|
|
||||||
`feels`
|
|
||||||
|
|
||||||
ttbp will ask you a few questions to get you started. after that, writing and
|
|
||||||
reading entries all happen within the program.
|
|
||||||
|
|
||||||
that's it!
|
|
||||||
|
|
||||||
### support
|
### support
|
||||||
|
|
||||||
if you're having trouble getting started, or run into program errors or strange
|
if you're having trouble getting started, or run into program errors or strange
|
||||||
behavior, please send internal tilde.team mail to sudoers@tilde.team and i'll try to
|
behavior, please ask on [#team](https://web.tilde.chat/?join=team) or send a mail
|
||||||
|
to [sudoers@tilde.team](mailto:sudoers@tilde.team) and we'll try to
|
||||||
sort things out!
|
sort things out!
|
||||||
|
|
||||||
there's also a function from the main menu that lets you send feedback/inquiries
|
there's also a function from the main menu that lets you send feedback/inquiries
|
||||||
to me directly; this uses internal tilde.team mail, which is what i'll respond
|
to us directly
|
||||||
to.
|
|
||||||
|
|
||||||
### writing entries
|
### writing entries
|
||||||
|
|
||||||
|
|
@ -82,8 +65,8 @@ by creating files with any date you want.)*
|
||||||
* you can use [markdown](https://daringfireball.net/projects/markdown/syntax)
|
* you can use [markdown](https://daringfireball.net/projects/markdown/syntax)
|
||||||
* you can use html
|
* you can use html
|
||||||
* you can also put things between `<!-- comments -->` to have them show up
|
* you can also put things between `<!-- comments -->` to have them show up
|
||||||
in the feed but not render in a browser (but people can still read
|
in the feed but not render in a browser (but people can still read them with
|
||||||
them with view-source)
|
view-source)
|
||||||
|
|
||||||
### reading other feels
|
### reading other feels
|
||||||
|
|
||||||
|
|
@ -118,8 +101,7 @@ directory.
|
||||||
|
|
||||||
if you opt to publish, the program creates a directory `~/.ttbp/www` where it
|
if you opt to publish, the program creates a directory `~/.ttbp/www` where it
|
||||||
stores all html files it generates, and symlinks this from your `~/public_html`
|
stores all html files it generates, and symlinks this from your `~/public_html`
|
||||||
with your chosen blog directory. your blog will also be listed on the [main ttbp
|
with your chosen blog directory.
|
||||||
page](https://tilde.town/~endorphant/ttbp).
|
|
||||||
|
|
||||||
you can also opt to publish to gopher, and the program will automatically
|
you can also opt to publish to gopher, and the program will automatically
|
||||||
generate a gophermap of your feels.
|
generate a gophermap of your feels.
|
||||||
|
|
@ -223,35 +205,3 @@ these are a few ideas being kicked around, or under active development:
|
||||||
|
|
||||||
other ideas are listed on github as
|
other ideas are listed on github as
|
||||||
[upcoming features](https://github.com/modgethanc/ttbp/issues?q=is%3Aissue+is%3Aopen+label%3A"upcoming+features") or [feature requests](https://github.com/modgethanc/ttbp/issues?q=is%3Aissue+is%3Aopen+label%3A"feature+request")!
|
[upcoming features](https://github.com/modgethanc/ttbp/issues?q=is%3Aissue+is%3Aopen+label%3A"upcoming+features") or [feature requests](https://github.com/modgethanc/ttbp/issues?q=is%3Aissue+is%3Aopen+label%3A"feature+request")!
|
||||||
|
|
||||||
### dependencies
|
|
||||||
|
|
||||||
(this section is only relevant if you plan on forking the repo and running an
|
|
||||||
instance of this yourself)
|
|
||||||
|
|
||||||
* [mistune](https://pypi.python.org/pypi/mistune)
|
|
||||||
* [inflect](https://pypi.python.org/pypi/inflect)
|
|
||||||
* [six](https://pypi.python.org/pypi/six)
|
|
||||||
|
|
||||||
|
|
||||||
### contributing
|
|
||||||
|
|
||||||
please check out my [contributor
|
|
||||||
guidelines](https://github.com/modgethanc/ttbp/blob/master/.github/CONTRIBUTING.md)
|
|
||||||
on github if you'd like to get involved with development!
|
|
||||||
|
|
||||||
if you find any bugs or strange behavior, please message me locally on tildemail
|
|
||||||
or open a github issue and i'll get back to you as soon as i can.
|
|
||||||
|
|
||||||
if you're interested in helping with the code, please drop me some tildemail!
|
|
||||||
|
|
||||||
i accept tips for development work on
|
|
||||||
[liberapay](https://liberapay.com/modgethanc)
|
|
||||||
|
|
||||||
### contributor shout-outs
|
|
||||||
|
|
||||||
thanks to:
|
|
||||||
|
|
||||||
* ~vilmibm, packaging help and gopher support
|
|
||||||
* ~sanqui, the bug swatter
|
|
||||||
* ~sinacutie, for css updates
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue