Skip to content

About

The official documentation for Memgraph open-source graph database.

Topics

Resources

Stars

13 stars

Watchers

4 watching

Forks

Repository files navigation

Discord

This repository is the source of the Memgraph documentation at memgraph.com/docs. The site is built with Nextra, and each page is an .mdx file in pages/.

Run the docs locally

You need Node.js 22 and pnpm 10.

git clone https://github.com/memgraph/documentation.git
cd documentation
pnpm i
pnpm dev

Open http://localhost:3000/docs. The page reloads as you edit.

To build the site as it's deployed, and serve the build:

pnpm build
pnpm start

The build also generates the sitemap and the llms.txt files.

Check your changes

Two checks run on pull requests: pnpm check on every one, and the examples check on pull requests into main (a release branch documents a Memgraph version that isn't out yet). You can run both before you push:

pnpm check
python3 scripts/check-examples.py --base origin/main
  • pnpm check checks links, section links, redirects and the sidebar. It takes about a second.
  • check-examples.py runs the Cypher examples on the pages you changed on Memgraph in Docker, and checks the procedure, function and flag names they use. It needs Docker.

After a deploy, python3 scripts/check-agent-access.py checks that AI agents can reach and read the published docs: llms.txt, robots.txt, markdown versions of pages and the docs MCP server. python3 scripts/check-external-links.py checks the links to other sites. Neither is a pull request check; run them locally or from the Actions tab.

Contribute

To fix or improve a page, open a pull request to main. To report a problem without fixing it, open an issue.

  • How to write a page: see AGENTS.md. It has the rules for frontmatter, headings, links, images, code blocks, the sidebar and redirects.
  • Docs for an unreleased Memgraph version go to that release's branch, release/<version>, not to main.
  • Pull request description: fill in the pull request template.

For questions, ask on Discord.

About

The official documentation for Memgraph open-source graph database.

Topics

Resources

Stars

13 stars

Watchers

4 watching

Forks

Releases

Packages

Used by

Contributors

Languages