単䞀 HTML ファむル 60k64k バむトの軜量な Wiki システム Feather Wikiフェザヌりィキに぀いおたずめおいたす。

2022幎5月に初公開のバヌゞョン 1.0.1 が公開されおいたす。

運営者が Feather Wiki で公開しおいるのは次がありたす。

🎈 Feather Wiki | 🎈 BALLOON | FU-SEN - English information


目次


公匏サむト

゜ヌスのメむン公開は 🎈 Codeberg になっおいたす。
GitHub はミラヌで Issues もありたすが、報告は Cordberg 偎掚奚です。


.html ファむルをダりンロヌドする

公匏サむトから FeatherWiki_●●.html をダりンロヌドし、任意の堎所に保存したす。

  Feather Wiki

このダりンロヌドした FeatherWiki_●●.html をブラりザで開いお䞋さい。


簡単な䜿い方

サむドバヌ New Page を遞ぶず
「New Page Title」のテキストボックスが衚瀺されるので、タむトルを入力したす。
Create で「Edit Page」画面になりたす。本文以倖は次のずおりです。

  • Page Title - タむトル。倉曎できたす。
  • Page Slug - URL 末尟 ?page=●● の ●● 郚分。重耇䞍可
  • Page Tags - タグ。「Add Exist Tag」で䜿甚枈みのタグを遞択できたす。
  • Parent - 芪ペヌゞを遞択したす。
  • Save - ペヌゞを保存したす。
  • Cancel - 線集をキャンセルしたす。
  • Delete - このペヌゞを削陀したす。

この蚭定は  で倉曎できたす。

Wiki Settings は Wiki 党䜓の蚭定を行えたす。

  • Wiki Title - タむトル。ブラりザのタブやサむドバヌ䞊郚に衚瀺されたす。
  • Wiki Description - 説明。タむトルの䞋に衚瀺されたす。省略可
  • Home Page - URL に ?page=●● がない堎合の衚瀺。「All Pages」でペヌゞ䞀芧
  • Page Order - ペヌゞの䞊び、改行気切りで耇数ペヌゞ指定できたす。
  • Custom CSS - デザむンを倉曎したい堎合、CSS をここに含めたす。
  • Custom JS - 機胜を远加できたす。プラグむン
  • Custom Head - <head> に远加するタグなどを远加したす。1.5.0
  • Include Static HTML - で <body> に本文などを含めたす。
    これを指定するず怜玢゚ンゞンで収集されやすくなりたすが、
    .html ファむルのサむズがおよそ 2 倍になりたす。
  • Publish - 公開向け。 で線集関連のボタンを非衚瀺にしたす。

Import & Overwrite with Other Feather Wiki file は
 アップグレヌド や Wiki の皮類倉曎に䜿甚できたす。

「Existing Images」で Wiki 内でアップロヌドした画像の管理ができたす。

ペヌゞを保存・線集・削陀した埌、サむドバヌの Save Wiki で
反映された .html ファむルの保存になりたす。
必芁であれば、.html ファむルの名前を倉曎しお構いたせん。
たた、この .html ファむルをサヌバぞアップロヌドしお公開できたす。


Tiddlyhost で䜿甚する

 Tiddlyhost

Tiddlyhost は 🎈 TiddlyWiki 向けのホスティングサヌビスですが、
Feather Wiki にも察応しおいたす。Tiddlyhost ぞ保存できる専甚の Feather Wiki です。

サヌバは アメリカ Dreamhost の VPS を䜿っおいるようです。
Wiki の衚瀺で若干埅たされたすが、
たずもに䜿うず Google などの怜玢結果は良い状態にできるかもしれたせん。

Sign up を遞択しおアカりントを䜜成したす。

  • Email - メヌルアドレス。通知が届くので、たずもに䜿っおいるアドレスを蚭定
  • Name - 名前。衚瀺されたす。
  • Username - ナヌザヌ名。省略可。これは Wiki のサブドメむンずは別 です。※
  • Password - パスワヌド
  • Password confirmation - パスワヌドをもう䞀床

※ 䞀぀のアカりントで耇数の Wiki を䜜成できる仕組みになっおいたす。

サむト䞀芧になりたす。なにもないので Create site で Wiki を䜜成しおいきたす。
「Claim Tiddlyspot site」は旧システム Tiddlyspot からの移行です

  • Choose a name - サブドメむン.tiddlyhost.com のサブドメむンになりたす。
  • Private -  で非公開。ログむンした時のみ衚瀺されたす。
  • Hub listed -  で  Tiddlyhost Hub に衚瀺されたす。
    䞍特定倚数に公開したい Wiki は  を入れたす。
  • Description - 説明。省略可
  • Tags - タグ。省略可

䞋の Show advanced settings を遞択し、「Advanced settings」を衚瀺し、
「TiddlyWiki version」で FeatherWiki を遞択したす。

Your sites で䞀芧衚瀺されたす。
サブドメむン.tiddlyhost.com を抌すず、Wiki の画面になりたす。
右に衚瀺されおいるアむコンは次のずおりです。

  •  Setting - 「Create site」ず同じ画面になり、倉曎できたす。
  •  Download - .html ファむルをダりンロヌドしたす。
    バックアップしたり、他サヌバで公開できたす。
  •  Link - Wiki を衚瀺したす。
  •  Upload - Wiki の .html ファむルをアップロヌドし、反映したす。
    「Download」した TiddlyWiki の埩旧、ロヌカルなどからの移行に䜿えたす。
  •  Delete - 䞀芧から削陀したす。

Download の .html ファむルは他サヌバぞ公開できたす。
他のサヌビスぞの移行や独自ドメむンを䜿甚した公開に䜿甚できたす。
逆に .html ファむルを Upload しお Tiddlyhost ぞ移行する事もできたす。

「Save Wiki」の代わりに Save Wiki to Server ず Save Wiki Locally ず衚瀺されたす。
Save Wiki to Server で Tiddlyhost の .html ファむルを曎新したす。


サヌバ保存できる Wiki を生成する

WebDAV を甚いお Wiki をサヌバ偎に保存する事ができたす。
実際  Tiddlyhost は WebDAV を甚いお Wiki 保存を実珟しおいたす
ここでは Caddy を甚いた方法で玹介しおいたすが、
WebDAV が動䜜する環境であれば、䜿甚できる可胜性がありたす。

 Caddy
🎈 Caddy | ふうせん🎈 FU-SEN

Caddy にはプラグむン WebDAV が必芁です。

 mholt/caddy-webdav | GitHub

プラグむンを含む Caddy は公匏のダりンロヌド、たたは xcaddy でビルドしたす。

 Download | Caddy
 caddyserver/xcaddy | GitHub

Caddyfile のサンプルは次で公開されおいたす。
BASIC 認蚌のパスワヌドは ‘caddy hash-password’ で生成できたす。

 Caddyfile.example | Codeberg Alamantus/FeatherWiki

Feather Wiki はサヌバ保存機胜を含むバヌゞョンずなりたす。
Codeberg リポゞトリの release からダりンロヌドしお䞋さい。
これを index.html ずしたす。

 releases | Codeberg Alamantus/FeatherWiki

  • Tern - WYSIWYG ゚ディタ  Markdown ゚ディタ
  • Swallow - WYSIWYG ゚ディタ
  • Bluethroat - Markdown ゚ディタ

Docker を甚いた環境で䜿甚する堎合、Dockerfile は次のようなものです。
index.html はビルドで削陀されないよう Persistent 領域に眮く必芁がありたす。
ここでは /srv が Persistent 領域にしおいる事ずしたす。
Caddyfile の参照先も合わせお蚭定しお䞋さい。

FROM caddy:builder AS builder
RUN xcaddy build --with github.com/mholt/caddy-webdav
 
FROM caddy:alpine
COPY --from=builder /usr/bin/caddy /usr/bin/caddy
COPY ./Caddyfile /etc/caddy/Caddyfile
COPY ./index.html /srv

ファむルサむズ

Git・Web サヌビスにより、1 ファむルの容量制限が存圚したす。
サヌビスにより 1 ファむル 10MB100MB 䜍です。

画像ファむルなどを Wiki 内に含める事ができたすが、むンポヌト
ファむルサむズが倧きくなるので、Wiki 倖で個別にアップロヌドし、
URL 圢匏で衚瀺するようにするのが䞀぀の回避手段です。

たた、皮類・パヌトに応じお異なる .html ファむルに分割し、
ファむルサむズを小さくする回避手段もありたす。


アップグレヌド

  Upgrading | Feather Wiki

Tiddlyhost を䜿甚しおいる堎合は Download を甚いお、
.html ファむルをダりンロヌドしお䞋さい。

埓来のバヌゞョンの .html ファむルを開き、Wiki Settings を開いお、
「Include Static HTML」ず「Publish」の  を倖しお保存しおおきたす。
生成する HTML を倉曎するプラグむンを Custom JS に远加しおいた堎合は、
これも削陀しお保存しお䞋さい。
この堎合は HTML 自䜓に反映させるため、
保存した埌にもう䞀床ファむルを開いお再床保存したす。

新しいバヌゞョンの .html ファむルをダりンロヌド・保存したす。
1.5.0 より配垃は 2 皮類になりたした。

  Downloads | Feather Wiki

.html ファむルを手動でアップロヌド・デプロむしおいる堎合は次のバヌゞョンです。

  • Wren - 通垞版旧 Chickadee・Dove・Finch
  • Warbler - サヌバ保存付旧 Bluethroat・Swallow・Tern

新しいバヌゞョンの .html ファむルをブラりザで開きたす。
サむドバヌ Wiki Settings より䞋郚にある
Import & Overwrite with Other Feather Wiki file を遞択したす。
ここでこれたで䜿甚しおいた Feather Wiki の .html を遞択したす。
これで Wiki の内容が反映されたすので、Save Wiki をしお保存したす。
その時 Wiki Settings の「Include Static HTML」ず「Publish」の  を倖しおいた堎合は
 を入れお有効にしおから保存したす。
保存した .html ファむルを開き盎しお、動䜜を確認しお䞋さい。

1.4 以前から 1.5 以降ぞの曎新で、「Custom JS」に <head> 関連を入れおた堎合、
1.5.0 より Custom Head が远加されたので、こちらに远加しお䞋さい。

Tiddlyhost は Upload でアップグレヌドを行った .html ファむルを反映しお䞋さい。


Q&A

TiddlyWiki ずは䜕が異なるのですか

TiddlyWiki はデフォルト状態で 2MB 以䞊ありたすが、
Feather Wiki のデフォルト状態は 0.06MB です。

そのため、画像は WYSIWYG ゚ディタ のアむコンのみで、
基本的にテキスト衚蚘になっおいたり、ペヌゞ構成も少なくなっおいたす。

TiddlyWiki は 1 画面に耇数の Tiddler を衚瀺できたすが、
Feather Wiki は普通に投皿のペヌゞ単䜍です。

Markdown を䜿っおいたすが、機胜しない文法がありたす。

Feather Wiki の 🎈 Markdown パヌサヌは 1.4.1 より MD.js を採甚しおいたす。

 thysultan/md.js | GitHub

1.4.0 たでは Snarkdown を採甚しおいたしたが、解釈されない事があったため、
たたサむズを曎に小さくできるよう、MD.js に切り替えられおいたす。

 developit/snarkdown | GitHub

いずれもサむズの小さい Markdown パヌサヌのため、完党に構文を察応しおいたせん。
期埅する衚瀺にならない堎合は HTML タグに倉曎するのが確実です。

逆に Markdown で存圚しおいない内郚リンク [[ペヌゞ]] および
[[名前|ペヌゞ]] が䜿甚できたす。
画像をアップロヌドした時も URL の代わりに独自のコヌドを䜿甚したす。

倖郚リンクを入れるず新しいタグで開いおしたいたす。

Feather Wiki の仕様により、<a href=" から始たるタグに
target="_blank" rel="noopener noreferrer を付䞎したす。
これにより倖郚リンクは新しいタブ新しいりむンドりで開くようになりたす。

<a href="URL">名前</a>

これは Markdown も含たれたす。

[名前](URL)

これを回避したい堎合、 <a href=" でなければ付䞎されないので

<a href='URL'>名前</a>

たたは

<a href=URL>名前</a>

ずするず新しいタブりむンドりで開く察象から倖れたす。

芋出しで日本語を䜿うず  のリンクが正しく動䜜したせん

1.3.1 たでは日本語は - に倉換されおしたいたす。
したがっお日本語 5 文字の芋出しは URL の末尟が #----- になっおしたいたす。

 Non-ASCII languages cause some problems #67 | Codeberg Alamantus/FeatherWiki Issues

1.4.2 たでにこの問題が察凊され、
日本語の芋出しでも URL をそのたた出力するようになっおいたす。

日本語衚瀺にできたすか

2022幎9月珟圚、英語衚瀺のみ提䟛されおいたす。
日本語を含め、他の蚀語での衚瀺は察応しおいたせん。

英語衚瀺ではありたすが、ペヌゞは日本語で入力できたす。

Google などの怜玢結果に衚瀺されたすか

 Google 怜玢 - site:feather.wiki

公匏サむトそのものが Feather Wiki で構築されおいたすが、
各ペヌゞを含めお、Google の怜玢結果に収集されおいたす。
しかも、公匏サむトは「Include Static HTML」を䜿甚しおいたせん。
぀たり Googlebot は JSON デヌタで入っおいおも正しく収集したすし、
?page=●● 付の URL も䞀぀の怜玢結果ずしお反映したす。

他の怜玢゚ンゞンクロヌラは JSON デヌタたで収取しおいない可胜性があるので、
「Include Static HTML」を 有効 にしおも良いかもしれたせん。

1.5 より Wiki Settings 内に「Custom Head」が远加されたしたので、
こちらに必芁なヘッダヌを入れる事で期埅する怜玢結果で衚瀺され、
SNS などでも効果が埗られるよういなりたした。

任意の meta タグなどを含める事ができたすか

1.5.0 より Wiki Settings に「Custom Head」が含たれ、
<head> 内のタグなどを容易に蚘茉できるようになっおいたす。
アナリティクスやサむト確認甚の <meta> タグをここで含められたす。
🎈 Open Graph protocol ず Twitter カヌド も远加できたす。

<link rel="canonical" href="https://example.net.eu.org/">
<meta name="theme-color" content="#eeeeee">
<link rel="icon" href="https://example.net.eu.org/favicon.ico">
<link rel="icon" type="image/png" href="https://example.net.eu.org/favicon.png">
<link rel="icon" type="image/png" href="https://example.net.eu.org/favicon.png">
<link rel="apple-touch-icon" sizes="256x256" href="https://example.net.eu.org/apple-touch-icon.png">
<meta name="theme-color" content="#ddeeff">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:title" content="タむトル">
<meta name="twitter:description" content="説明">
<meta name="twitter:image" content="https://example.net.eu.org/ogp.png">
<meta property="og:type" content="website">
<meta property="og:title" content="タむトル">
<meta property="og:description" content="説明">
<meta property="og:site_name" content="サむト名">
<meta property="og:image" content="https://example.net.eu.org/ogp.png">

Publish を有効にしおファむルを保存しおしたいたした。線集する事はできたすか

.html ファむルを Web ブラりザで参照した時、
URL 末尟に ?page=s を付けお参照しお䞋さい。
「Wiki Settings」画面になるず共に線集関連のボタンも衚瀺されたす。
この状態で「Publish」の を倖しお Update する事で、
線集可胜な状態にできたす。

珟圚のバヌゞョンを知る方法は

Web ブラりザで衚瀺しおいる時、右䞋の「Powered by Feather Wiki」のうち
Feather Wiki のずころにカヌ゜ルを圓おお䞋さい。
Version: Dove_1.3.1 などず衚瀺されたす。

たたは゜ヌスを芋たす。Minify が適甚されおいるので芋にくいですが、
Ctrl+F で怜玢フォヌムを衚瀺し、 name=version ず入力しお䞋さい。
次のように meta タグが存圚しおバヌゞョンが蚘茉されおいたす。

<meta name=version content=Chickadee_1.3.1>

別のバヌゞョンぞ倉曎したいのですが

 アップグレヌド ず同じ方法を甚いお、
別のバヌゞョンぞ移行する事ができたす。

Neocities で公開するずスクリヌンショット衚瀺で背景が真っ癜になる事がありたす。

Feather Wiki が JS でデザむンを展開する前に
Neocities のキャプチャが発生しおしたう事がありたす。
背景が癜い衚瀺は Static HTML の出力なので、
「Include Static HTML」を 有効 にすれば
背景が真っ癜でもある皋床のテキストは出力された状態になりたす。

 Neocities screenshots may result in static HTML (black text and white background, no CSS). #62 | Codeberg Alamantus/FeatherWiki Issues

ペヌゞ運営者が報告しおいたした。1.4.0 でこの問題が解決されおいたす。

この issues で衚瀺されおいるプラグむンを適甚しおいた堎合は
1.4 系では䞍芁になっおいるので、削陀しお䞋さい。