Spear プロジェクトの OSS レポジトリです🚀
Spear は静的サイトジェネレータで、ヘッドレスCMSである Spearly との相性が良いツールです。 また Spearly を利用しなくても静的サイトを構築することも出来ます。
Spear には以下のパッケージがあります。
| Packages | Status | Details | README Link |
|---|---|---|---|
spear-cli |
 |
SSG 本体 | README |
create-spear |
 |
Spear プロジェクト作成ツール | README |
cms-js-core |
公開中 | Spearly のコンテンツ埋め込みコンバーターライブラリ | README |
spearly-flutter |
計画中 | Flutter へ CMS コンテンツを埋め込めるライブラリ | - |
spearly-svelte |
計画中 | Svelte Kit へ CMS コンテンツを埋め込めるライブラリ | - |
spearly-astro |
計画中 | Astro へ Spearly 埋め込みを簡単にするプラグイン | - |
- プロジェクトの作成
npm create spear@latest コマンドで質問に答えてプロジェクトを作成します。
$ npm create spear@latest
Namespace(port=undefined, action='create', projectName=undefined, src=undefined)
### Welcome to Spear CLI ###
? Name of your project test-project
? Use Spearly CMS Yes
? Choose template type basic
? Enter your Spearly CMS API KEY abc
## Your project was created 🎉
To start using, run the following command:
cd test-project
yarn install
To start local server, run
yarn dev
To build static sources, run
yarn build- 関連パッケージのインストールとプロジェクトのビルド
build タスクを実行すればビルドできます。(dev タスクを実行すると開発サーバーが起動しデバッグモードになります。)
$ cd test-project
# If you use the npm.
$ npm run build
# If you use the yarn.
$ yarn build
# If you use the pnpm.
$ pnpm run build参加ありがとうございます！
Spear プロジェクトはオープンソースです。いつでもコントリビュートをお待ちしております🚀 もしコントリビュートしたい場合は、コントリビューションガイドを読んでください。
次のような貢献大歓迎です。
- ライブラリを利用したフィードバック
- バグや機能要望を Issue へ登録
- Issue にある計画中の機能を実装する