🧐 How To

Edit This Site

It's pretty easy!

Quick edits

If you've found a typo, want to reword something, or add a small section, feel free to edit directly in GitHub:

Open Docs

You can just find the .mdx file you want to modify, and hit the little edit icon in GitHub.

Bigger edits

If you'd like to add a page, or to be able to preview your changes before you publish, you can clone the eddev repo locally, and run the docs/ Next.js application. Content sits in content/docs as .mdx files, which you can edit in VSCode. When you're done, just push back up to Github.

You can copy/paste the below code to clone, open your editor and start up the dev server in one go.

git clone git@github.com:ed-digital/eddev.git
cd eddev/docs
code .
yarn
yarn dev