rawdog md

rawdog-md

最小限の構成を備えた、Caveman レベルのシンプルな Markdown から HTML への静的サイト ツール。

motherfuckingwebsite.com からインスピレーションを受け、内部で Go テンプレートと HTML を使用します。

特徴

• セットアップ、カスタマイズ、迅速な展開が簡単です。
• 肥大化した依存関係やフレームワーク コードはありません。
• HTML、CSS、JS、SVG、JSON、XML の縮小化
• カスタマイズ可能な CSS を使用して、JavaScript を使用せずに構文の強調表示をサポートします。
• すぐに YouTube、Twitter、Bilibili ビデオの埋め込みをサポートします。
• ローカル開発用のライブ リロード サーバー。
• すぐに始められるさまざまなスターター テンプレート

?次のような場合にこれを使用するとよいでしょう。

• ツールを学ぶのではなく、サイトの作成に集中したいと考えています。
• Markdown とカスタム HTML/CSS を使用して Web サイトを構築したいと考えています。
• 不必要なインストールを行わずにシンプルなセットアップを希望する場合。

?中心となる概念

• 最小構成: rawdog-md は、最小構成で使用するように設計されています。スターター テンプレートを選択して、すぐにマークダウンで投稿を書き始めます。
• 意見: このツールは、汎用の静的サイト ジェネレーターを意図したものではありません。これは、いくつかの単純なテンプレート ページを含む静的サイトという、非常に特殊なユースケースで使用することを目的としています。より汎用的で高度なものが必要な場合は、Hugo または Jekyll をチェックしてください。
• 独自のスタイルを持ち込む: rawdog-md は最小限のスタイルを提供します。ただし、単なる CSS および HTML ファイルであるため、調整は非常に簡単です。
• クロスプラットフォーム: Windows、Linux、MacOS で使用できます。

インストール

rawdog-md は、Windows、Linux、MacOS で使用できます。パッケージ マネージャーを介して手動でインストールすることも、ソースからビルドすることもできます。

窓

PowerShell 経由でインストール (クリックして展開)

1. PowerShellを管理者として開きます
2. このコマンドを実行します

   Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
   iex (irm https://raw.githubusercontent.com/dwiandhikaap/rawdog-md/main/.installer/powershell/install.ps1)

3. 終わり！これで、ターミナルでrawdコマンドとして使用できるようになります。

Scoop 経由でインストールする

1. スクープをインストールする
2. rawdog-md をインストールする

   scoop install https://raw.githubusercontent.com/dwiandhikaap/rawdog-md/main/.installer/scoop/rawdog-md.json

3. 終わり！これで、ターミナルでrawdコマンドとして使用できるようになります。

アンインストール方法:

scoop uninstall rawdog-md

手動でインストールする

1. 最新リリースページへ
2. rawd-{version}-windows-amd64.zipファイル名を持つものをダウンロードします。
3. zipファイルを好きな場所に解凍します
4. 抽出したフォルダーを PATH に追加します。方法がわからない場合は、このガイドを参照してください
5. 終わり！これで、ターミナルでrawdコマンドとして使用できるようになります。

Linux

Bash 経由でインストール (クリックして展開)

1. ターミナルでこのコマンドを実行します

   curl -fsSL https://raw.githubusercontent.com/dwiandhikaap/rawdog-md/main/.installer/bash/install.sh | bash

2. 終わり！これで、ターミナルでrawdコマンドとして使用できるようになります。

手動でインストールする

1. 最新リリースページへ
2. rawd-{version}-linux-{architecture}.tar.gzファイル名の URL をコピーします。
3. ターミナルでこのコマンドを実行します

   wget {copied-url} -O rawd.tar.gz
   tar -xvf rawd.tar.gz
   sudo mv rawd /usr/local/bin
   rm rawd.tar.gz

4. 終わり！これで、ターミナルでrawdコマンドとして使用できるようになります。

MacOS

Bash 経由でインストール (クリックして展開)

1. ターミナルでこのコマンドを実行します

   curl -fsSL https://raw.githubusercontent.com/dwiandhikaap/rawdog-md/main/.installer/bash/install.sh | bash

2. 終わり！これで、ターミナルでrawdコマンドとして使用できるようになります。

手動でインストールする

1. 最新リリースページへ
2. rawd-{version}-darwin-{architecture}.tar.gzファイル名の URL をコピーします。
3. ターミナルでこのコマンドを実行します

   wget {copied-url} -O rawd.tar.gz
   tar -xvf rawd.tar.gz
   sudo mv rawd /usr/local/bin
   rm rawd.tar.gz

4. 終わり！これで、ターミナルでrawdコマンドとして使用できるようになります。

ソースからビルドする

Go を使用してビルドする (クリックして展開)

1. Goをインストールする

2. rawdog-md をインストールする

   go install github.com/dwiandhikaap/rawdog-md

   これにより、バイナリがrawdではなくrawdog-mdとしてインストールされます。 rawdに変更したい場合は、Go bin ディレクトリ内のバイナリ ファイルの名前を変更できます。

   go install詳細については、このリファレンスを参照してください。

3. 終わり！

使用法

1. 新しいプロジェクトを作成し、プリセットのテンプレートを選択します

   rawd init

   プロジェクト名と使用するテンプレートを尋ねられます。

2. 次に、プロジェクトディレクトリに移動します

    cd < your-project-name >

3. 開発サーバーを起動します

   rawd watch

4. ブラウザを開いてhttp://localhost:3000にアクセスします。

5. 新しい投稿を作成するには、 pagesディレクトリに新しいファイルを作成します。 Markdown、Go テンプレート、または HTML を使用できます。

6. テンプレートを編集するには、 templateディレクトリに移動します。

7. 変更を保存するたびに、サーバーはサイトを再構築し、ブラウザを更新します。

8. 完了したら、サイトを構築します

   rawd build

?貢献する

プルリクエストは大歓迎です。大きな変更の場合は、まず問題を開いて、変更したい内容について話し合ってください。