markdown zen
1.0.0
MarkdownZen は、マークダウン ドキュメントの作成と管理を効率化するように設計された Web アプリケーションです。ユーザーフレンドリーなインターフェイスと強力な機能を備えた MarkdownZen は、Zenful なマークダウン体験のための頼りになるツールです。
始める前に、次のソフトウェアがコンピュータにインストールされていることを確認してください。
リポジトリのクローンを作成します。
ターミナル/コマンド プロンプトを開き、プロジェクトを保存する場所に移動します。次に、次のコマンドを実行します。
git clone https://github.com/daniel752/markdown-zen.git
これにより、プロジェクト ファイルがコンピュータにダウンロードされます。
cdコマンドを使用して、作業ディレクトリをクローンされたプロジェクト フォルダーに変更します。
cd markdown-zen
プロジェクト フォルダー内で、単一のコマンドを使用してサーバーとクライアントの両方に必要な依存関係をインストールします。
npm run setup-project
これにより、アプリのサーバー コンポーネントとクライアント コンポーネントに必要なパッケージがインストールされます。
アプリケーションを起動するには、ルート (markdown-zen/) フォルダーで次のコマンドを実行します。
npm run dev
このコマンドはサーバーとクライアントの両方を同時に起動するため、ブラウザーでアプリにアクセスできます。
Web ブラウザを開いてhttp://localhost:5173に移動します。ここに MarkdownZen アプリがあります。
Docker を使用して MarkdownZen を実行することもできます。次の手順に従います。
Docker イメージをプルします。
Docker Hub から MarkdownZen Docker イメージをプルします。
docker pull daniel752/markdown-zen:v1.0.0
コンテナを実行します。
MarkdownZen コンテナを開始します。
docker run -d daniel752/markdown-zen:v1.0.0
コミュニティからの貢献を歓迎します。 MarkdownZen に貢献するには、次の手順に従います。
GitHub リポジトリ ページの右上にある [フォーク] ボタンをクリックします。これにより、GitHub アカウントの下にリポジトリのコピーが作成されます。
フォークされたリポジトリのクローンをローカル マシンに作成します。
git clone https://github.com/your-username/markdown-zen.git
プロジェクト ディレクトリに移動します。
cd markdown-zen
機能の新しいブランチを作成します。
git checkout -b feature/my-new-feature
必要な変更を加えてコミットします。
git commit -m 'Add some feature'
フォークされたリポジトリに変更をプッシュします。
git push origin feature/my-new-feature
GitHub 上の元のリポジトリにアクセスし、[新しいプル リクエスト] ボタンをクリックして変更をレビューのために送信します。
このプロジェクトは MIT ライセンスに基づいてライセンスされています。詳細については、LICENSE ファイルを参照してください。
