GNU General Public License v3.0

项目介绍

kmwallio/ThiefMD 是一个托管在 GitHub 上的开源项目,主要使用 Vala 编写,采用 GNU General Public License v3.0 许可证,目前获得 188 个 Star、9 次 Fork。

仓库全名
kmwallio/ThiefMD
开源许可证
GNU General Public License v3.0
Star 数
188
Fork 数
9
未关闭 Issue
37

README 摘要

ThiefMD ThiefMD is a Markdown & Fountain editor that helps with organization and management. It is heavily inspired by Ulysses. Initial code was based on work from Quilter. Installation from Flatpak ThiefMD is now available on Flathub. Make sure you've added flathub to your system. Arch User Repository ThiefMD is in the Arch User Repository thanks to Mark Wagie. You can follow these instructions, use yay, or use…

完整内容见 GitHub 原始 README 或本页 。

常见问题

ThiefMD 用什么语言开发?

主要使用 Vala 编写,采用 GNU General Public License v3.0 许可证,目前有 188 个 Star。

ThiefMD 可以免费商用吗?

仓库标注的许可证为 GNU General Public License v3.0,商用前请先阅读仓库 LICENSE 文件确认授权范围。

如何获取 ThiefMD 的源码?

可以直接克隆仓库:git clone https://github.com/kmwallio/ThiefMD.git,默认分支为 master;安装与运行步骤见仓库 README。

ThiefMD 最近还在维护吗?

仓库最近一次更新为 4月5日,当前有 37 个未关闭 Issue;Star 数为 188,可作为社区活跃度的参考。

关于

GitHub 原始描述(英文)

The markdown editor worth stealing. Inspired by Ulysses, based on code from Quilter

描述取自 GitHub 官方 API,保持仓库作者书写的原文。

语言占比

C
CSS
JavaScript
Meson
Python
Shell
Vala

README

ThiefMD

ThiefMD is a Markdown & Fountain editor that helps with organization and management. It is heavily inspired by Ulysses. Initial code was based on work from Quilter.

Tests

Installation from Flatpak

ThiefMD is now available on Flathub. Make sure you’ve added flathub to your system.

flatpak install flathub com.github.kmwallio.thiefmd

Arch User Repository

ThiefMD is in the Arch User Repository thanks to Mark Wagie. You can follow these instructions, use yay, or use your favorite AUR helper.

yay -S thiefmd

Features

  • Basic library at the moment
  • Switch between documents
  • Hide Library and Document Switcher
  • Live Preview
  • Sheet Management
  • Shortcut key bindings
  • Themes
  • Export (DocX, ePUB, PDF, HTML, Markdown, WriteFreely, Ghost, WordPress, and more…)
  • Import (DocX, ePUB, HTML, rst, textile, and more…)
  • Search Ctrl+F for the current file, and Ctrl+Shift+F for the entire library
  • Writing Statistics
  • Focus Mode (Word, Sentence, and Paragraph)
  • Spell Check, Write-Good Style Suggestions, and Grammar Check
  • Basic Bibtex Support
    • Open File & Syntax Highlighting
    • Right-Click Insert Citation Support in Markdown Documents
  • Basic Screenwriting Support
    • Open Fountain Files
    • Export to HTML & PDF

Translating

Poeditor can be used to help translate ThiefMD.

Planning

  • Better library organization
  • Enhanced Export Tooling
  • Project Notes
  • Better import support for Screenplays

Resources

Screenshots

Download themes from https://themes.thiefmd.com or make your own. Ulysses Themes can also be imported through the preferences Ctrl+,.

Drag and Drop organizing of the library.

Live Preview & Export Preview

Typewriter Scrolling.

Focus Mode

Write-Good recommendations and highlighting.

Fountain syntax highlighting.

Dependencies

libwritegood-vala, writeas-vala, ghost-vala, wordpress-vala, Bibtex-vala and the Ulysses Theme Parser are used as git sub-modules.

Ubuntu

meson
ninja-build
valac
cmake
libspelling-1-dev
libwebkitgtk-6.0-dev
libmarkdown2-dev
libjson-glib-dev
libglib2.0-dev
libxml2-dev
libarchive-dev
libgtk-4-dev
libgee-0.8-dev
libgtksourceview-5-dev
libsecret-1-dev
libadwaita-1-dev
liblink-grammar-dev

Fedora

vala
meson
ninja-build
cmake
libmarkdown-devel
webkitgtk6.0-devel
gtk4-devel
gtksourceview5-devel
libspelling-devel
libarchive-devel
json-glib-devel
glib2-devel
libxml2-devel
libgee-devel
libsecret-devel
libadwaita-devel
link-grammar-devel

Building

$ git clone https://github.com/kmwallio/ThiefMD.git
$ cd ThiefMD
$ git submodule init
$ git submodule update --remote --recursive
$ meson build && cd build
$ ninja
$ sudo ninja install

Prebuilt packages are available.

Building and Running the Tests

By default the code is built without tests. To compile the test suite the project has to be told to do so by setting the meson variable build_tests.

After that they can be built and run by ninja:

$ meson configure -Dbuild_tests=true build
$ cd build && ninja && ninja tests

Acknowledgments

评论

暂无评论