プロジェクトをはじめたい（myst init）

$ myst init

myst initで設定ファイル（myst.yml）を作成します。 myst.ymlは実行したディレクトリに作成されます。

そのままmyst startが実行され、プレビュー用のサーバーがローカルホスト（デフォルトは http://localhost:3000）に起動します。

注釈

myst initを実行したディレクトリが空の場合、myst startは失敗します。 その場合は、なんでもいいので.mdファイルを作成すればOKです。

トップページとしてよく使われるファイル名は、 index.md / index.ipynb、 README.md / README.ipynb、 main.md / main.ipynb があります。参考までに。

他ツールから移行したい

$ mkdir mystmd  # myst用のディレクトリを作成する
$ cd mystmd
$ myst init

Sphinxなどの他ツールから移行する場合、プロジェクト直下にmystmdのようなmyst用のディレクトリを作成するとよいです。