Replace Edit this page with DraftView

Workflows•4 min read|||

Use this integration when you want contributors to edit docs visually before they open a pull request or merge request.

What contributors experience

  • They click Edit this page from your docs site.
  • DraftView opens with the target file loaded.
  • They edit visually.
  • DraftView guides platform authorization, fork creation, commit, and request creation.

Integration URL pattern

Link to DraftView with the source file URL in url.

GitHub example:

https://www.draftview.app/edit?url=https://github.com/owner/repo/blob/main/docs/page.md

GitLab example:

https://www.draftview.app/edit?url=https://gitlab.com/group/project/-/blob/main/docs/page.md

Setup steps

Locate the template where your docs site builds Edit this page links.

Keep your existing source file URL generation, then wrap it with the DraftView URL pattern.

Open a page, click Edit this page, edit, and confirm DraftView opens a pull request on GitHub or a merge request on GitLab.

Notes

  • DraftView works with Markdown, MDX, and AsciiDoc.
  • AsciiDoc include targets can be edited in their own sessions.
  • Supported source URL formats are blob and edit URLs from GitHub and GitLab.
  • You can paste URLs copied from the browser. DraftView accepts query strings and fragments.

Related pages