当サイトは https://numaduki.github.io に移転します。
このURL nu.skr.jp は2023年7月頃に終了しますので、それまでにリンクの変更をお願いします。
またゴーストを使用している人は、それまでにネットワーク更新をお願いします(一度ネットワーク更新を行うことで、新URLに対応します)


last update: 2022/06/19

sinonome / ユーザーマニュアル

ファイル

主要なファイルやディレクトリについて、解説します。

sino.exe
実行ファイルです。これを実行することで、ウェブサイトを出力します。

\profiles\default
記事のテキストや画像ファイル等、あなたが用意するデータを入れるディレクトリです。
中には既にサンプルのデータが入っています。

\themes(ディレクトリ)
テーマを格納するディレクトリです。
中にはサンプルのテーマ(\sample-blog)が入っています。

当マニュアルでは、

  • ユーザーマニュアル: \profiles\default 内のファイルを編集し、ウェブサイトを出力する方法
  • 開発マニュアル: \themes 内に、独自のテーマを作る方法

について解説します。

基本設定

\profiles\default 内の settings.txt で、基本の設定を行います。
「キー, 値」のフォーマットで書いていきます。
カンマの後ろには半角スペースが必要ですのでご注意ください。

sitetitle,
サイト名

sitedescription,
サイトの概要

siteauthor,
サイトの作者

template_directory, default
使用するテンプレートのディレクトリ名

output_directory, sitefile\
サイトファイル一式を出力するパス
(相対パスで指定し、最後は必ず \ で終わるようにします)
(上のディレクトリ「..\」は指定しないようにしてください)

output_skipifnotchange, 1
出力結果に変化がない場合は出力しない
0→出力する 1→出力しない

archive_autosplit_entrycount, 10
記事アーカイブの1ページあたりの記事数

public_html_url,
実際に公開するURL

remove_blankline, 1
空行がある場合、削除するかどうか
0→そのまま残す 1→削除する

記事を書く

タイトルと本文を書く

記事は、\profiles\default\entries 内の entry.md というファイルに書きます。
ファイル入力のフォーマットは以下の通りです。

# ひなまつり

今日はひなまつりです。
この歳になってはもう関係ないな。

甘酒ではなくストロングゼロ飲んで寝る。

まず、タイトルを#の後に書きます。

その次の行から、本文を入力します。
なお、テキストのみを書く場合は、HTMLタグを入力する必要はありません。
上記の例の本文は、以下のようなHTMLに自動で変換されます。

<p>
今日はひなまつりです。<br>
この歳になってはもう関係ないな。
</p>
<p>
甘酒ではなくストロングゼロ飲んで寝る。
</p>

なお、タイトルの頭に(draft)と書くと、その記事は下書き扱いになります。
下書きの記事は、sinonomeに読み込まれません。

メタ情報を書く

しかしこのままでは、ブログ記事の「投稿日時」がわかりません。

そこで、タイトルの次の行に、<!-- ~ -->で囲んで、この記事の情報を記述します。
記事のタイトルと本文ではない、それ以外の情報をメタ情報といいます。

# ひなまつり

<!--
DATE: 2020-03-03
OUTPUTPATH: hinamaturi2020
-->

今日はひなまつりです。
この歳になってはもう関係ないな。

甘酒ではなくストロングゼロ飲んで寝る。

DATEは、記事の年月日です。
OUTPUTPATHは、このブログ内での、この記事のIDです。

これらは、必要なものだけ書けばいいです。
DATEを入力しなかった場合は、sinonomeが処理を行った時点の日時が使用されます。
OUTPUTPATHを入力しなかった場合は、適当な数字が割り振られます。

DATEは「年4桁-月2桁-日2桁」もしくは「年4桁-月2桁-日2桁 時2桁:分2桁:秒2桁」のフォーマットで書いてください。
これ以外のフォーマットで書いた場合は、未入力とみなされます。

画像を使う

本文に画像を表示する場合、まず画像を \profiles\default 内の \files ディレクトリに入れます。

そして通常通り、HTMLタグ(imgタグ)、またはMarkdown(後述)で入れ込みます。
ただし通常と違うのは、ファイルパスに{root}を使用するという点です。

<img src="{root}logo.png" alt="ロゴ画像">
または
![ロゴ画像]({root}logo.png)

{root}は、ページの出力ディレクトリの階層に合わせて、相対パスに置き換えられます。
{root}を書かないと、トップページ以外でうまく画像が読み込まれませんので、注意してください。

複数の記事を書く

記事は、先ほど説明したフォーマットを繰り返し書いて、いくつでも書けます。
新しい記事は、上に追記していってください。

つまり、以下のようになります。

# こどもの日

<!--
DATE: 2020-05-05
OUTPUTPATH: kodomo2020
-->

今日は晴れ。こどもの日です。

長崎では鯉の形の生菓子を食べます。  
甘くておいしい。

# エイプリルフール

<!--
DATE: 2020-04-01
OUTPUTPATH: aprilfool2020
-->

今日はエイプリルフールです。

大村公園は桜が満開です。  
缶ビール持って花見に行こうかな。

# ひなまつり

<!--
DATE: 2020-03-03
OUTPUTPATH: hinamaturi2020
-->

今日はひなまつりです。  
この歳になってはもう関係ないな。

甘酒ではなくストロングゼロ飲んで寝る。

(..以下、繰り返し)

この例ではタイトル・メタ情報・本文の間に空行を1行入れていますが、空行は好きなだけ入れて構いません。

記事にタグをつける

各記事に、タグを付けることができます。
sinonome では、使用するタグはあらかじめ \profiles\default ディレクトリ内の tags.txt に記述しておきます。

科学,science
宇宙,universe
思想・宗教,thought-religion
生活,life
音楽,music
文学,literature
スポーツ,sport
サブカルチャー,subculture
食べ物,food

「タグ名,タグID」で1行ずつ入力します。
タグIDは半角英数記号で入力してください。
このフォーマットの都合上、タグ名やタグIDに半角カンマ「,」を含めることはできません。

あとは、タグを付けたい記事のメタ情報領域に「TAG: タグ名」のフォーマットで書くだけです。
カンマで区切って、複数付けることができます。
tags.txt に書いた順序で書く必要はありません。

# クリスマスイブ

<!--
DATE: 2020-12-24
OUTPUTPATH: xmaseve-2020
TAG: 生活,食べ物
-->

(..本文)

記事にタグを付けると、同じタグを付けた記事の一覧を表示することができます。

ページを書く

sinonome は、記事だけではなく、ページも作成することができます。
ページは記事と違い、上部に表示されるメニューからアクセスできますので、ブログの説明や、著者のプロフィールなどを記載するのに向いています。

ページの内容は、\profiles\default\webpages 内の page.md ファイルに入力します。
フォーマットは以下の通り。

# このブログについて

<!--
OUTPUTPATH: about-blog
-->

このブログはサンプルブログです。  
ごゆっくりご覧ください。

# 作者について

<!--
OUTPUTPATH: about-author
-->

作者は猫である。名前はまだない。  
メールアドレスもない。ないないばっかでキリがない。

(..以下、繰り返し)

基本的には、記事の書き方と全く同じです。

ファイルごとのメタ情報を書く

各記事、各ウェブページにメタ情報を記述できるのは述べた通りですが、それらを記述する「記事ファイル」や「ウェブページファイル」にも、メタ情報を入力することができます。

サンプルテーマを使用する場合、書く必要はありません。
ただし、テーマによってはここに内容を記述することがあります。

ファイルのメタ情報も、<!-- -->(HTMLのコメントアウト)で囲んで入力します。
書く場所は、ファイルの一番最初です。
(それより下に、記事データ・ウェブページデータが入ります)

<!--
TITLE: sinonome 開発マニュアル
OUTPUTPATH: sinonome-develop
DEFINE: 置換前,置換後
-->

(以下、記事データ・ウェブページデータの繰り返し)

詳しくは、リソースを参照してください。

本文の記法について

入力した本文は、自動でウェブページ表示用の言語(HTMLといいます)に変換されます。

sinonomeでは、文章を普通に改行するだけでは、ウェブページ上では改行されません。
ウェブページ上で改行を行いたい場合は、行の末尾に2つ半角スペースを入力するか、手動で改行用のタグ<br>を入力してください。

Markdown について

本文はMarkdown 形式として処理されます。
Markdown 形式のうち、特に「CommonMark」と呼ばれる文法を使用しています。
参考: https://qiita.com/Prof-Cheese/items/9629438b06aacc068c98

 

以上です。あとは、sino.exe を実行するだけです。
\profiles\default\SITEFILE というディレクトリに、書いた記事とページが載ったウェブサイトが生成されます。 ブラウザーで開いて確認してください。