A simple static site generator
Project description
TinySSG
概要
TinySSGは、ファイルベースルーティングのシンプルな静的サイトジェネレータです。 ページを簡単な構造のTinySSGPageクラスを継承したPythonコードで記述することで単純さと柔軟性を両立しています。
インストール
pip install tinyssg
使い方
ディレクトリ構成
以下のようにディレクトリを構成します。ディレクトリ名はオプション引数で変更可能です。
--- proect
|-- pages SSGの対象となるPythonファイルを配置します
|-- libs SSG・デプロイの対象にならないPythonファイルを配置します(ライブラリなど)
|-- static SSGの対象にならない静的ファイルを配置します(css, 画像など)
|-- dist SSGの結果が出力されるディレクトリです。このディレクトリの中身をWebサーバに配置することでWebサイトとして公開できます。
|-- static staticディレクトリはこのディレクトリにコピーされます
pages, libs, staticディレクトリは、開発サーバー起動時に監視され、ファイルが変更されると自動的にサーバーを再起動します。
ページの作成
Pageディレクトリ内にPythonファイルを作り、TinySSGPageクラスを継承したクラスを作成します。
from tinyssg import TinySSGPage
class IndexPage(TinySSGPage):
def query(self):
return {
'title': 'Index',
'content': 'Hello, World!'
}
def template(self):
return '''
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>{{ title }}</title>
</head>
<body>
<h1>{{ title }}</h1>
<p>{{ content }}</p>
</body>
</html>'''
queryメソッドでテンプレートに渡すデータを返し、templateメソッドでHTMLテンプレートを返します。
TinySSGは、これらのメソッドの返り値を使ってHTMLを生成します。
queryメソッドが返すデータは、Python辞書形式またはPython辞書のリスト形式である必要があります。
辞書形式の場合はpythonファイル名のHTMLファイルが生成され、リスト形式の場合はPythonファイル名と同じディレクトリが作成され、デフォルトでは1からの数字.htmlのファイル名でHTMLファイルが生成されます。
returnの際にタプルとしてリストと一緒にキー名を表す文字列を返すと、そのキーに対応する値をファイル名としてHTMLファイルが生成されます。
TinySSGはデフォルトでは単純にテンプレートの{{ キー名 }}で囲まれた部分をqueryメソッドの返り値である辞書のキーに対応する値で単純に置換するだけですが、
renderメソッドをオーバーライドすることで、より複雑な処理を行うこともできます。Jinja2などのテンプレートエンジンを使うこともできます。
また、translateメソッドをオーバーライドすることで、レンダー後のテキストを最終的なHTMLに変換する処理を定義することもできます。
ここでmarkdownライブラリを使って変換する処理を記述すればテンプレートをHTMLではなくMarkdownで記述することができます。
それぞれページごとに定義することになりますが、単純なPythonクラスですので複数のページに適用したい場合は共通部分を定義したクラスを作成し、それを継承することでコードをコピーすることなく簡単に適用することができます。
HTMLの生成
python -m tinyssg gen
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file tinyssg-0.0.3.tar.gz.
File metadata
- Download URL: tinyssg-0.0.3.tar.gz
- Upload date:
- Size: 11.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b0e31eac1b0ae6f0079ca4c3c428e70a51ea52873466146a22e3e7cfea360d93
|
|
| MD5 |
fc411c95ca8fd7534022d692be209e38
|
|
| BLAKE2b-256 |
986d7b44cd517939e52dfbc51775c6026cc1657146fbd8508d90d62324aa983a
|
File details
Details for the file tinyssg-0.0.3-py3-none-any.whl.
File metadata
- Download URL: tinyssg-0.0.3-py3-none-any.whl
- Upload date:
- Size: 9.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
355cbebd84bd819c1585cd039f1481b31f9a0fab0be509bc4fe054a28119abe3
|
|
| MD5 |
d88735da1213a8b21b0cc557485791f2
|
|
| BLAKE2b-256 |
4c7ecaf77032ee5b23db6820213260b6aedf05e0f4c4f20a77bf11d597373219
|
