FerryDocs
ContributingDocs site

Run the site on your machine

Three commands start the dev server of the docs. Each change of a page shows in the browser.

Edit on GitHub
A pagean .mdx fileDev servernpm run devBrowserlocalhost:3000

You change a page and save the file.

1 / 3

Install the packages

Terminal
cd docs
npm install

Start the dev server

Terminal
npm run dev                    # → http://localhost:3000

Open the site

Open http://localhost:3000 in your browser.

If port 3000 is in use

Terminal
npm run dev -- --port 3210     # when port 3000 is taken

What you need

ToolVersionUse
20.19 or newerThe and the build
See What you needOnly to regenerate the reference pages

On this page