Tiddlywiki或許是最適合用来寫教程類文檔的軟件

理由如下:

一, tiddlywiki可以內嵌字體

我寫的是倉頡輸入法教程《尹卂倉頡規則正述》,裏面有不少倉頡字元,要用特別的字體,如:

同時,tiddlywiki的擴展性極好,我們把字體做成macro,之後我們只要寫<<ij 字元名稱>>,就可以顯示這個字元:

二,tiddlywiki是單文件html

我猜測很多人寫好一個教程,就是希望它能導出之後提供給人下載閱讀。

能適應屏寬的html或許是最好的導出格式,其它的諸如pdf並不能適應屏寬。

如果用notion或evernote,把一系列文章導出成單個html文件,似乎並不好導出。而tiddlywiki就直接是一個單文件,一切圖片、字體等盡在其中。

三,tiddlywiki的「非線性」信息整理非常靈活

本人自有一套信息整理辦法,在用上tiddlywiki之後,發現它的特性可以跟我很好的配合。

因為我的風格是想到一點就快速記錄,而這時我並不一定能馬上組織成一篇正式的文段。tiddlywiki允許我們把一切都當作「草稿」,這些草稿不斷的修改重組,最終就能形成一篇文章。

四,tiddlywiki能直顯svg

svg矢量圖不僅文件體積小,而且作圖方便,無限放大也不會失真。並且它還可以做成動畫以及交互事件。

我相信大多數教程類文檔是需要矢量圖的,雖然你也可以考慮做成png位圖。但是當你想修改某些文字或調整位置時,位圖是很難改的。(請見尹規的首頁封面)

我用手機上的simplector畫完svg之後,就可以直接導入tiddlywiki。整個過程行雲流水,非常方便。

五,tiddlywiki不需要聯網,手機電腦都可編輯,它是真正意義上的「跨平臺」

假設我上傳一張圖片都需要聯網,甚至要連到國外的服務器,那就不夠快速穩定。

同時,當我們見到一個軟件的時候,首先會看它支持甚麼平臺。tiddlywiki既是一個「軟件」,也是一個「文件」。它從来都不擔心跨平臺的問題。


當然我不是說tiddlywiki樣樣都行,只是,用它来寫單個教程,以及做一些筆記之類的話,它應該是可以勝任的。

由於我用tiddlywiki只有一個月,它的很多功能和用法可能我還不是很懂,因此如果有沒有講對的地方歡迎補充。

我经常把tiddlywiki文件搞坏.

2 个赞

你有無限次的機會重来。

但是如果你把onenote、evernote、notion、思源、typero、wiznote搞壞…

但是tiddlywiki的使用逻辑有些与众不同,一直没搞明白。

既然你也是刚开始使用,可以面向没用过它的人做一下介绍吗?

1 个赞

要全面介紹,估計也是一篇跟《尹規》一樣龐雜的教程。下面是隨筆寫寫:

你想做甚麼

首先你要有一個奮鬭目標,你知道你想把它做成甚麼結果。

喜歡它的輸入框

喜歡一個note軟件,始於輸入框,終於輸出效果。我對tiddlywiki的輸入框非常滿意,要是我能把它弄出来就好了。

英文要好

雖然有繁中和簡中教程,但仍不免涉及英文。對於習慣使用英文版軟件的朋友就問題不大,我直接用英文版。

要懂html跟js

雖然不懂也問題不大,但是現在html跟js教程到處都是,它也沒甚麼難度。

如果你本身就是程序員,就可以開始做一個你需要的macro。

要懂文件管理

1.在手機裏新建一個tiddlywiki/
2.不要甚麼都放到一個tw
3.永遠保留一個empty.html
4.改完記得覆蓋保存
5.保存時準確命名

一些已有教程

https://tw-cn.netlify.app/

你也可以去搜索「tiddlywiki教程」,現在中文資料呈現越来越多的趨勢,tiddlywiki的理念正在吸引越来越多的人。

高手示例

https://onetwo.ren/wiki/

1 个赞

然后在标题上来一句或许是最适合……

如果我只用了一個月,就能用有限的能力去完成一個龐雜的教程文檔,不正說明了tiddlywiki更適合嗎?

不過我也希望你告訴我有沒有其它的軟件比tiddlywiki更適合寫這類文檔。或許,gitbook?

同時,tiddlywiki的功能幾乎是可以無限擴張的,比如我做的這個頁面:

地址是:http://blog.ejsoon.win/#unicode轉碼

你也可以去玩。

我以前用来做法规库. 输入内容的时候经常搞坏. 每次都要修复.

所以做好后, 我是一点都不敢修改的.

我个人觉得这种单html文件, 其实不大适合存储数据, 内容太多或者文件太大就很容易崩. 这种事情其实有个一两次就会劝退很多人了. 我估计这也是这个软件不火的主要原因.

所以后来我基本上不再使用tiddlywiki.

2 个赞

不懂甚麼是法規庫,是不是法律學習筆記?

我其實非常同意你的看法。如果你想保存數據,做一個網站或博客,其實tiddlywiki並不適合。因為數據保存是它的短板

我認為最好的數據保存及展示方法是像wordpress這樣的php+mysql,或者其它的前後端數據庫配合的程式。但是如果你想寫一個文檔,比如倉頡輸入法規則,tiddlywiki或許是一個最好的選擇。

但是,這也是看個人。如果你不覺的有必要提供下載,那直接當成一篇文章来寫,也就不一定要用tiddlywiki。

但是即便是wordpress之類的博客網站,如何引用woff字體也是需要研究的。

不是学习笔记. 就是一个法律汇编, 我用tiddlywiki主要是可以检索和互链.

做好之后效果还是很好的. 只是调整和修改选项的时候很容易搞坏.

不敢苟同。
TiddlyWiki 作为 Notion 等的替代工具用于个人知识管理或许是个不错的选择。
但是,谈到写文档,
前有 GitBook 之流,JS 下有 docsify、VuePress 等,Python 下诸如 Sphinx,以及 R 生态中的 bookdown,哪个不比 TiddlyWiki 好?
我认为「重器轻用」远比拿个锤子看什么都是钉子的 All in One 要好。

問題是你這些都不是單文件,也不跨平臺。

谁规定一定要单文件的?手机上装个 termux 和 markdown 编辑器,写完直接推送 github 然后自动构建算跨平台吗?但,为什么写文档要跨平台呢,生产力?不觉得搞笑吗?

首先我個人不懂如何用手機推送github,同時github越来越難連了。你要依賴網絡始終不夠穩定,何況是一個正在被監管的外網?

再者,單頁面的markdown文件之間不能自動關聯,無法全文檢索。

如果連跨平臺都做不到,還有甚麼好說的?別人以為我在玩手機,實際上我是在寫文檔。

如果你说跨平台是为了兼容平板设备,那么我同意你的观点。
如果你说跨平台是为了在手机上写文档的话,那我不能同意。
手机写文档这件事本身就很奇怪。屏幕小导致视口小,按键小,打字速度什么的都会受到影响,而且手机这样的小型设备多码一会字也很不舒服。

一般的手機確實如此,一個軟鍵盤彈出来就佔了半個屏幕。

(但是…我用的是priv全鍵盤手機,並且用的是倉頡輸入法…)

先不談我的特殊情況。假設你主要用電腦寫完了一整個文檔。但是有一日你出去玩,用手機發現它有一處需要修改,這時你就可以直接用手機改掉…

同時,說不定還是有人喜歡用手機打篇長文,寫文檔?畢竟手機拿在手上很方便,可以帶出去旅遊,邊玩邊寫。

有没有一种可能国内的 coding、gitee 也支持 CI/CD 持续集成与部署?

markdown 文件关联,通过锚点这样算吗?

[An Internal Link to a Section Heading](/guides/content/editing-an-existing-page#modifying-front-matter)

搜索的话,基于 algolia 的效果还行吗?

如果实在一定要在「生产力」大杀器手机上写的话,有没有一种可能写好后直接同步到各个平台,然后得空玩电脑的时候直接提交就行?

1 个赞

用手机打长文,可能是网文作者…?

手机拿在手上确实很方便,但是这时候在写一篇很长的文章,我实在想不出来方便在哪了…

我觉得你想弄成网页单文件这点并非是图一个跨平台,而是希望当软件出现问题的时候还有办法打开你的数据…

以及一大堆文章导出单个HTML文件什么的…

只能说可能在某些场景下确实挺合适,但是用【最适合】这个字眼还是噱头大于实际了。
不过多一个选择也挺好的。

話說這個「壞」是甚麼情況?我用Git管理的話會不會好點,有點興趣想試用下。

場景就是教程類文檔。不過,既然一個人打算寫一個「教程」的話,那他應該對他要寫的東西已經成竹在胸了吧。因此他就可以用手機寫。那種邊學邊寫的不算。

tiddlywiki有一個「把長文分段」的功能,同時有「組合同標籤成一篇文章」的功能。

或許用一段時間,你就會喜歡上這種寫作跟組織方式。