mirror of https://github.com/supermemoryai/supermemory.git synced 2026-05-18 06:03:49 +00:00

History

Dhravya Shah 4e1e1ab5e2 fix: duplicate in doc		2025-03-23 21:10:41 -07:00
..
api-reference/endpoints	fix: api reference page	2025-03-23 21:06:22 -07:00
changelog	Documentation edits made through Mintlify web editor	2025-03-23 20:18:37 -07:00
essentials	v2 docs	2025-03-23 20:27:24 -07:00
images	redepl	2025-01-30 21:18:18 -07:00
logo	initial docs setup	2025-01-30 20:48:51 -07:00
snippets	initial docs setup	2025-01-30 20:48:51 -07:00
favicon.png	initial docs setup	2025-01-30 20:48:51 -07:00
image.png	Documentation edits made through Mintlify web editor	2025-03-23 20:18:37 -07:00
introduction.mdx	Documentation edits made through Mintlify web editor	2025-03-23 20:18:37 -07:00
mint.json	fix: duplicate in doc	2025-03-23 21:10:41 -07:00
openapi.json	fix: api reference page	2025-03-23 21:06:22 -07:00
quickstart.mdx	v2 docs	2025-03-23 20:27:24 -07:00
README.md	docs no submodule	2025-01-30 18:46:37 -07:00
self-hosting.mdx	initial docs setup	2025-01-30 20:48:51 -07:00

README.md

Mintlify Starter Kit

Click on Use this template to copy the Mintlify starter kit. The starter kit contains examples including

Guide pages
Navigation
Customizations
API Reference pages
Use of popular components

Development

Install the Mintlify CLI to preview the documentation changes locally. To install, use the following command

npm i -g mintlify

Run the following command at the root of your documentation (where mint.json is)

mintlify dev

Publishing Changes

Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard.

Troubleshooting

Mintlify dev isn't running - Run mintlify install it'll re-install dependencies.
Page loads as a 404 - Make sure you are running in a folder with mint.json