markdropDocs
Open Markdrop
All releases
NewMarkdrop Guides

Markdrop Guides: import from GitHub and keep in sync

Bring a repository's docs into a guide (Markdown, GitBook Git Sync, Mintlify, Docusaurus or MkDocs) and keep it in sync: every push to the branch updates the guide.

  • Mintlify, Docusaurus, MkDocs, GitBook and plain Markdown
  • Read-only GitHub app: Contents and Metadata only
  • Web app
  • API
  • Import from GitHub is a new way to start a guide. Pick a repository, a branch and a folder; Markdrop Guides works out the format and previews the pages and sidebar before anything is imported.
  • Five formats: a plain Markdown folder, GitBook Git Sync (SUMMARY.md), Mintlify (docs.json or mint.json, tabs included), Docusaurus (sidebars.js, read without running it) and MkDocs (mkdocs.yml). Their callouts, tabs, steps, cards and expandable sections become the guide's own blocks, and images and PDFs become the guide's files.
  • Keep in sync: with the Markdrop Guides GitHub app installed, every push updates the guide's drafts, or publishes it automatically if you choose. A renamed file keeps its page and history, and its old address redirects.
  • GitHub is the source of truth for the pages it brought: the editor shows where a page comes from, with Edit on GitHub. Pages you add in the editor are never touched.
  • Private or public: the app reads only the repositories you choose, read-only. A public repository imports without it.
  • Settings › GitHub has the sync history, Sync now, the mode, and Disconnect (the pages stay). An OpenAPI file found in the repository can become the guide's API reference.

Docs updated