Web Editor
Edit your Jamdesk docs in the browser: browse your connected repo, edit MDX with a live preview, and commit to GitHub to trigger a build.
Edit your documentation in the Jamdesk dashboard, without cloning the repo or opening a terminal. Open a page and edit its MDX next to a live preview. Commit your changes to your GitHub branch. Every commit starts a build, the same as a git push.
It is the browser version of local preview and the VS Code extension. Use it for a quick edit from anywhere.
Open the Editor
Click Editor in the dashboard sidebar. The editor opens on your project's connected repository and default branch.
The editor requires a connected GitHub repository and a wide screen (desktop). Narrower windows show a "wider browser needed" notice. Every project owner and team member can use it, on every plan.
The Interface
| Pane | What it does |
|---|---|
| Navigation (left) | Your site's pages and groups, read from docs.json. Filter pages, open the Configuration (docs.json) editor, or Add page. |
| Editor (center) | An MDX code editor for the open file, with syntax highlighting and a word count. |
| Preview (right) | A live render of the page, updated as you type. Toggle Desktop / Mobile and Light / Dark to check how it looks. |
The top left shows the branch you're editing. Switch branches with the branch picker.
Edit a Page
Click a page in the navigation to open it. Edit the MDX in the center pane. The preview updates as you type. Your edits stay as a local draft in your browser until you commit. Move between pages without losing work. Nothing reaches GitHub until you commit.
Add a Page
Click Add page to create a new page without leaving the editor:
- Pick a starter template.
- Enter a title. Jamdesk derives the file name from it.
- Choose the navigation group.
The new page opens as a draft. Jamdesk writes the new .mdx file and the docs.json navigation entry in one commit.
Commit Changes
Commit your pending changes to GitHub to publish them:
Click Commit. The dialog lists every file you've changed (a page, docs.json, or several at once).
Type a commit message, or click Generate to have Jamdesk write one from your diff.
Jamdesk commits the changes to your current branch and starts a build. Track it on the project's Builds page.
Discard the current page's unsaved changes with Revert. It restores the committed version.
Working With External Changes
The editor flags the branch when another push lands on it while you edit. On commit, each file that changed upstream opens as a three-way merge. Reconcile the two versions there. Your local edits are never discarded.
Committing from the editor writes a real commit to your repo. It triggers the same build pipeline as a push from your machine. If your docs live in a subdirectory of the repo (monorepo setup), the editor reads and writes there.
Requirements
| Requirement | Detail |
|---|---|
| GitHub connected | The project must have a connected repository and branch. |
| Desktop browser | A wide screen (roughly 1400px+). The editor is not available on mobile widths. |
| Access | Any project owner or member. The usual write locks (for example, a past-due subscription) apply. |