Import Content

You don't have to start from scratch. DocStar can import an existing API spec or collection as a new collection, and it can import Markdown files as pages into a collection you already have.

#

What you can import

Source File format What DocStar creates
OpenAPI 3 .json or .yaml A new collection with your endpoints
Swagger 2.0 .json or .yaml A new collection (converted to OpenAPI automatically)
Postman collection .json A new collection with your requests and folders
DocStar export .json A copy of a collection exported from DocStar
Markdown .md, .markdown or .mdx New pages inside an existing collection

Other formats, such as XML, are not supported. If DocStar doesn't recognize a file, it shows "We don't recognize/support this format."

#

Import a collection

Use this for OpenAPI, Swagger, Postman and DocStar export files.

  1. Click the collection name at the top of the left sidebar to open the collection menu.
  2. Click Import collection.
  3. In Import Collection, drag your file into the upload area, or click files to browse.
  4. Click Import.

Untitled design (5).png

DocStar creates a new collection in your current workspace and opens it. Imported pages and endpoints normally start as drafts, so you can review them before you publish.

If your workspace has no collections yet, you can also click the import icon next to Add Collection in the sidebar.

#

Import Markdown pages

Use this to move written docs from another tool, a Git repo or a folder of Markdown files.

  1. Open the collection you want to add pages to.
  2. Click Settings in the left sidebar.
  3. Open the Collection Actions tab.
  4. Next to Import Pages, click Import.
  5. Drag in your files, or click Select .md / .mdx files. You can select several files at once.
  6. Click Import.

Each file becomes a new page in the collection. Markdown import is not available for Embed collections.

#

Keep docs in sync with GitHub

If your docs live in a GitHub repository and change often, connect the collection to GitHub instead of importing by hand. Open Settings > Integrations in the collection. See GitHub Sync.

#

Tips

  • To copy a collection between workspaces, use Export Collection in Collection Actions, then import the file in the other workspace.
  • Check imported endpoints for base URLs and auth settings before publishing. See Environments and Authorization.
  • Large specs can take a moment to import. Wait for DocStar to open the new collection before importing again.
Built with DocStar