Simple text files, such as this one, have a number of really great properties:
Recent advancements have made things even better. The standardization of the line terminators eliminates entire classes of interoperability problems. Introduction of Unicode UTF-8 encoding opens the format to a vast number of symbols in a largely transparent way. Lightweight markup languages demonstrated that conventions can be used to create beautiful representations without sacrificing the legibility of the source code.
SuperTXT builds on this foundation with new principles:
Do you want to learn more? A good place to start is the [:@getting started] guide.
Here are some places to immerse yourself in this realm.
Check out our log of articles here:
If you're reading this site using your web browser, that's great. All of the web functions and more are also available via Secure SHell (SSH). You can browse this site in high fidelity over SSH with a little help from two tools: brsh, and [:@cats]. You'll need to generator yourself an encryption key first.
ssh-keygen # The defaults are usually fine and the passphrase can be empty
brew tap supertxt/tap ssh://email@example.com/git/st-brew brew install supertxt/tap/cats supertxt/tap/brsh
From the browsing shell (brsh) you can navigate here using cats like this.
If you have the Go language tools installed here is another way to install commands.
go install supertxt.net/git/cats/cmd/cats@latest go install supertxt.net/git/st-int/cmd/brsh@latest
This site doesn't require any special tools. You can use ssh from any shell (bash, zsh, brsh, or other Unix shell) like this:
ssh firstname.lastname@example.org cat whats-sshla.s.txt # .s.txt
If you use [:@cats] the command is much simpler with a single pathname2 for the document, like what you would expect from other SSH tools.
There are also git repositories here that can be cloned.
git clone email@example.com:git/cats
Site search is available with the "srch" command.
ssh firstname.lastname@example.org srch <<EOF inline link EOF
You can learn more about this site's built-in commands in the manual. Check out ccmnt (conventional comments) command for leaving feedback.
ssh email@example.com man # Show list of available commands ssh firstname.lastname@example.org man git # Show available git commands
This site contains a number of specifications used here, and can be used elsewhere too.
The following git repos are available here.
Some content on this site is signed, such as git commits. Here's the list of allowed signers.
HAVE SOME FEEDBACK FOR US?
You can give us [:@conventional comments] on these documents. Here's how you can give this document some praise.
ssh email@example.com ccmnt 00-intro.s.txt <<EOF praise: Looks good EOF