Tickle

commit 7fba4dbbd6b9bd764b7b83b020f8cbeaa5f3e7c7 Author: Xananax Date: Mon Jun 27 23:20:12 2022 +0200 first commit diff --git a/examples.md b/examples.md new file mode 100644 index 0000000..e1c66d0 --- /dev/null +++ b/examples.md @@ -0,0 +1,4 @@ +# Examples of things to do with Tickle + +1. A documentation site. This is one! The repo of this site is an example of Tickle being used for docs. +2. A blog. TODO: add a link \ No newline at end of file diff --git a/files.txt b/files.txt new file mode 100644 index 0000000..85d7337 --- /dev/null +++ b/files.txt @@ -0,0 +1 @@ +readme.md 2022-03-03 Tickle \ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 0000000..4030ed4 --- /dev/null +++ b/index.html @@ -0,0 +1,258 @@ + + + + Tickle + + + + + + + + + +

+ + + diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..4e99a63 --- /dev/null +++ b/readme.md @@ -0,0 +1,68 @@ +# Tickle + +Possibly the simplest way to self-publish on the web today. + +Tickle is a self-publishing platform with **no build system**, and **no tooling required**. + + +## What is Tickle? + +A small, small, small script that will load markdown files, parse them in the browser, and display them. + +Accent is kept on keeping the script aired, readable, and easy to hack. + +By default, Tickle will: + +1. Read a text file containing a list of posts +2. Load the first post +3. Parse the markdown +4. Display the list of links, and the pages + +Tickle is small enough that a moderately knowledgeable programmer should be able to make it do whatever they want. + + +## How do I use Tickle? + +1. write markdown files +2. reference your files in a text file called "files.txt" +3. upload everything on some server + +We have a [neat little UI to help you do all of that](https://git.poto.cafe/yagich/ticle-godot-frontend). You don't have to use it, but it's neat. + +Here are more detailed explanations, for different knowledge levels. + +- [I do not care about tech stuff, I just want to publish](/#/tutorial-publishers.md) +- [I can write some code, give me detailed explanations](/#/tutorial-hackers.md) + +It's important to know that Tickle is an *idea*. Think of it as a specification. We have a few examples listed [here](examples.md) + + +## FAQ + +### Q: Why would I want to use this rather than medium/similar? + +**A**: Medium locks your content behind paywalls and spies on users. Other providers have similar issues. If you care about being in control of your data, or not having to deal with embargos, or not spying on people, or not helping corporations, or keeping your tools simple and lightweight, then you'll probably like Tickle. If you don't care, then using something like Medium probably fits your needs better. + +### Q: What if I want custom functionality, but don't know programming at all? + +**A**: Check the [examples](examples.md) first, and see if there's something for you. Otherwise, write to us! Find us on X or Y, and shoot your request. Maybe we'll get to it + +### Q: Everything in the browser? Isn't that bad for SEO? + +**A**: Who cares? SEO is dead. No one finds blogs organically by googling them, the first pages are entirely occupied by clickbait. If your articles will be shared, they will be shared by people, and the technical side of your page counts zilch there + +### Q: Isn't it bad for performance? + +**A**: Again, who cares? For Facebook, a microsecond lost means a large amount of people will not see ads fast enough, that loses them money. But someone who comes to read your blog will wait 300ms to read your article, no worries. + +### Q: What about accessibility? + +**A**: We haven't started working on this, but we care about this a lot, and we will make sure Tickle websites are accessible, at least in the default blog recipe. + +### Q: What's the license? + +**A**: The license is [[upcoming]] + +### Q: "Tickle"? + +**A**: It stands for "article"... Or maybe "art", "tickle"? It's a neat name found by Otto. \ No newline at end of file diff --git a/tutorial-hackers.md b/tutorial-hackers.md new file mode 100644 index 0000000..fc34771 --- /dev/null +++ b/tutorial-hackers.md @@ -0,0 +1,9 @@ +# Tutorial & Info for peeps who can code a bit + +Tickle consists of 3 distinct and simple parts: + +1. load text files +2. parses markdown files in the browser +3. displays the markdown files + +To parse markdown files, the default implementation uses Micromark, but feel free to plug any parser you like. \ No newline at end of file diff --git a/tutorial-publishers.md b/tutorial-publishers.md new file mode 100644 index 0000000..17e50c1 --- /dev/null +++ b/tutorial-publishers.md @@ -0,0 +1,44 @@ +# I want to use Tickle, but I don't want to do anything technical + +Unfortunately, we couldn't remove entirely all the technicalities. But we've managed to keep them fairly low. + +There are 4 steps to writing articles in Tickle: + +1. Write the articles in Markdown +2. List the articles in a file +3. Optionally, preview the site locally before uploading +4. Upload everything on a server + +We have a desktop app that takes care of steps 1, 2, and 3 (and maybe some day step 4!). It's comfy, made with love, and you can install it from https://git.poto.cafe/yagich/ticle-godot-frontend + +But if you want to do the things manually, read on. You need to do step 4 manually either way. + +## 1. Write A Few Articles + +You will need some knowledge of Markdown. This is how we write the articles. It's really not hard! In fact, it looks very similar to how you already use characters in chat for emphasis. Check [a reference here](https://commonmark.org/help/). Create a document, call it "my-first-article.md" for example (`.md` stands for "markdown"). Write some text in it. + +## 2. Create the List of Files + +Once you have written a document, you then open a new file, call it "files.txt". At the top, write: + +``` +my-first-article.md 2022-03-03 My First Article +``` + +After saving the file, you're done! You can write more articles, and reference them in the same text file, one per line. + +At this state, the site is "ready". You can upload it, but before that, you probably want to preview it. + +## 3. Preview the site + +You will need to run a server. The easier server to run is [our own](https://git.poto.cafe/yagich/ticle-godot-frontend), but if you want other options, you want to search for "easy http server", and see what you get. + +- TODO: list a few good options here + +Once you have the server up and running, you can open a browser to the address the site opened. Usually, something like http://localhost:3000. The number is arbitrary and might be anything; it depends on the server. + +Once you're satisfied, time to upload + +## 4. Upload the site + +TODO: write procedure \ No newline at end of file