formiko(1)

✨ NAME ✨

formiko — the reStructuredText and MarkDown editor with a live preview, bestie 💖

She's a manual page, and honestly? She ate. This is the formiko(1) page from the General Commands Manual, and we're about to give her main character energy 👑

---

🌸 SYNOPSIS 🌸

formiko [options] [FILE]

---

🦋 DESCRIPTION 🦋

Okay so picture this: Formiko is a reStructuredText and MarkDown editor and live previewer, all in one lil package. Iconic behavior, no cap.

She's written in Python with Gtk3 and Webkit2. For the parsing girlies, she uses Docutils and the recommonmark Common Mark parser. Slay.

And in this version specifically — listen up — she uses SourceView as her editor and GtkSpell3 as her spell checker. Typos? Not on her watch 🎀

---

💅 OPTIONS 💅

• -h, --help — shows you the help options, so you know what's up 🙈
• -p, --preview — preview only. Just the vibes, no editing ✨
• FILE — tells formiko which file to open when she starts up. And if you don't specify one? She loads you a blank file labeled "Untitled Document" in ReStructuredText format. A fresh start, a clean slate, a new era 🦋

---

🍓 FILES 🍓

• ~/.config/formiko.ini — your personal config file, bestie. Formiko stores your options in here automatically whenever you make a change. She's thoughtful like that 💖
• ~/.cache/formiko/window.ini — your personal cache file. This is where she keeps the deets about your window size and your paned panels 🪟
• ~/.cache/formiko/WebKitCache — this one right here? Your WebKit preview cache. That's it, that's the girl 🧚

---

💀 BUGS 💀

Found a bug? First of all, oof, and second of all, please report it at the GitHub issues tracker. See <https://github.com/ondratu/formiko/issues> — the devs wanna know, fr fr 😭

---

👑 Author 👑

Ondřej Tůma (mcbig@zeropage.cz) — the legend behind all this. Respect the icon 🫶

---

⭐ version 2.0.0, dated 18 Jan 2018, brought to you by the General Commands Manual — and that's the whole page, periodt 💅🌈