プロジェクトをはじめたい(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用のディレクトリを作成するとよいです。