sveltin

sveltin

Sveltin is a CLI (Command Line Interface) created to boost the developers productivity working on SvelteKit v1.xx powered static websites .

Sveltekitバージョン

最新のSveltekitバージョンは1.8.3です。 Sveltekitはv1.xxに到達し、その後、新しいメジャーリリースまでこれ以上の破損は予想されません。テスト済みバージョンに固執することにしましたが、Sveltekitを混乱なしに今後のマイナーバージョンにアップグレードできるはずです

概要

Sveltinは、シンプルで迅速で強力なCLIです。

• Scaffold Sveltekit搭載のWebサイト
• リソース、LIB、エンドポイントを生成します
• リソースにコンテンツを追加します
• メニュー構造、サイトマップ、RSSを生成します
• サイトSEO（メタデータ、json-ld、opengraph）を簡単に準備する

Sveltinが提供します：

• バニラCSS、SASS/SCSS、Tailwind CSS、BULMA、BOUTSTRAPのすぐ外のサポート
• Svelteコンポーネントを使用する準備ができました

クイックスタート

コマンドがほとんどなかったため、Sveltinは筋肉を曲げますか？

NOTE : each command can be executed in interactive way so do not need to pass arguments and flags to it.

 # Create a project with TailwindCSS support
sveltin init myBlog --css tailwindcss

# Move to the project folder
cd myBlog

# Install all the dependencies
sveltin install

# Create a public page and compose it with Svelte
# (http://localhost:5173/contact)
sveltin new page contact --svelte

# Create a public page and compose it with Markdown
# (http://localhost:5173/about)
sveltin new page about --markdown

# Create a 'posts' resource
sveltin new resource posts

# Add new content to the posts resource
# (http://localhost:5173/posts/getting-started)
sveltin add content getting-started --to posts

# Add a 'category' metadata
# (http://localhost:5173/posts/category)
sveltin add metadata category --to posts --as single

# Run the server
sveltin server

ドキュメント

Sveltinの詳細については、ドキュメントをご覧ください。

インストール

？前提条件

• git
• ノード（V16.9.0以上が必要です）

Homebrew経由のOSXとLinux

HomebrewはGitとノードもインストールします。

 # Tap a new formula:
brew tap sveltinio/sveltin

# Install:
brew install sveltin

スクープ経由の窓

 # Tap a new bucket:
scoop bucket add sveltinio https://github.com/sveltinio/scoop-sveltin.git

# Install:
scoop install sveltinio/sveltin

インストールします

Installation is done by using the go install command. In this case, ensure to have Go (v1.17 or higher) installed on your machine:

go install github.com/sveltinio/sveltin@latest

手動で

リリースページから特定のOS用の事前にコンパイルされたバイナリをダウンロードできます。コピーしてバイナリを抽出してから、ローカルビンフォルダーに移動する必要があります。以下の例を参照してください。

curl https://github.com/sveltinio/sveltin/releases/download/ ${VERSION} / ${PACKAGE_NAME} -o ${PACKAGE_NAME}
sudo tar -xvf ${PACKAGE_NAME} -C /usr/local/bin/
sudo chmod +x /usr/local/bin/sveltin

CLIコマンドとオプション

Sveltinには、Sveltekitプロジェクトへの対処を支援するために、一連のコマンドとサブコマンドが付属しています。

各コマンドは、インライン引数またはインタラクティブで実行できます。

$ sveltin -h

sveltin is the main command to work with SvelteKit powered static website.

Usage:
  sveltin [command]

Available Commands:
  add         Add content and metadata to a resource
  build       Builds a production version of your static website
  completion  Generate the autocompletion script for the specified shell
  deploy      Deploy the website over FTP
  generate    Generate static files (sitemap, rss, menu)
  help        Help about any command
  init        Initialize a new sveltin project
  install     Install the project dependencies
  migrate     Migrate existing sveltin project files to the latest sveltin version ones
  new         Create nee resources, pages and themes
  preview     Preview the production version locally
  server      Run the development server
  update      Update your project dependencies

Flags:
  -h, --help      help for sveltin
  -v, --version   version for sveltin

Use " sveltin [command] --help " for more information about a command.

Sveltin init

sveltin init is the main command to scaffold a project.

Alias: create

詳細はこちらをご覧ください。

sveltin new

sveltin new is the main command to generate pages, resources (routes) and themes for your project.

Alias: n

（クリックして利用可能なサブコマンドのリストを展開します）

サブコマンド	エイリアス	説明
新ページ	p	新しいパブリックページを作成するコマンド。
新リソース	r	新しいリソースを作成するコマンド。

詳細はこちらをご覧ください。

sveltin add

sveltin add is the main command to add content and metadata to existing resources.

Alias: a

（クリックして利用可能なサブコマンドのリストを展開します）

サブコマンド	エイリアス	説明
追加コンテンツ	c	既存のリソースの新しいコンテンツを作成するコマンド。
Add-Metadata	m	sveltekitリソースとしてコンテンツに新しいメタデータを追加するコマンド。

詳細はこちらをご覧ください。

sveltin generate

sveltin generate is used to generate static files like sitemap, menu structure or rss feed file.

Alias: g

（クリックして、Avilable Subcommandsのリストを展開します）

サブコマンド	説明
生成されたメニュー	メニュー構成ファイルを生成します。
sitemapを生成します	sitemap.xmlを生成します。
生成RSS	rss.xmlファイルを生成します。

詳細はこちらをご覧ください。

Sveltinインストール

sveltin install is used to initialize the Sveltin project getting all depencencies from the package.json file.

Alias: i

詳細はこちらをご覧ください。

Sveltinアップデート

sveltin update is used to update all depencencies from the package.json file.

詳細はこちらをご覧ください。

Sveltinが移動します

sveltin migrate is used to migrate existing sveltin project files to the latest Sveltin version ones.

詳細はこちらをご覧ください。

Sveltinサーバー

sveltin server is used to run the VITE server.サーバーを実行するために、Svelte-Kit定義のコマンドをラップします。

Alias: s , serve , run , dev

詳細はこちらをご覧ください。

Sveltinビルド

sveltin build is used to build a production version of your static website. It wraps sveltekit-build command.

Alias: b

詳細はこちらをご覧ください。

Sveltinプレビュー

sveltin preview is used to run a preview for the production version locally.

詳細はこちらをご覧ください。

Sveltin Deploy

sveltin deploy is used to deploy your website over FTP on your hosting platform.

詳細はこちらをご覧ください。

Sveltin完了

sveltin completion generates the autocompletion script for the specified shell (bash|zsh|fish|powershell).

詳細はこちらをご覧ください。

貢献

ドキュメント、テーマ、チュートリアル、ブログ投稿、バグレポート、問題、機能リクエスト、機能の実装、プルリクエストなど、あらゆる種類の貢献は大歓迎です。

詳細はこちらをご覧ください。

依存関係

Sveltinは多くの優れたオープンソースライブラリを活用しています：

名前	バージョン	ライセンス
バブル	0.16.1	mit
bubbletea	0.24.1	mit
リップグロス	0.8.0	mit
バリデーター	10.15.4	mit
ナメクジ	1.13.1	MPL-2.0
FTP	0.2.0	ISC
は	1.4.1	mit
アフェロ	1.10.0	Apache-2.0
コブラ	1.7.0	Apache-2.0
ヴァイパー	1.26.0	mit
prompti	0.2.5	mit
GJSON	1.7.0	mit
SJSON	1.2.5	mit
文章	0.13.0	BSD-3節

？ライセンス

Sveltinは、Apache 2.0ライセンスの下でライセンスされている無料およびオープンソースソフトウェアです。

拡大する