https://github.com/memgraph/documentation
The official documentation for Memgraph open-source graph database.
https://github.com/memgraph/documentation
documentation graph-database memgraph
Last synced: about 2 months ago
JSON representation
The official documentation for Memgraph open-source graph database.
- Host: GitHub
- URL: https://github.com/memgraph/documentation
- Owner: memgraph
- License: mit
- Created: 2023-08-01T12:39:52.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-06-18T13:22:47.000Z (10 months ago)
- Last Synced: 2025-06-18T14:19:10.453Z (10 months ago)
- Topics: documentation, graph-database, memgraph
- Language: MDX
- Homepage: https://memgraph.com/docs
- Size: 68.5 MB
- Stars: 10
- Watchers: 5
- Forks: 13
- Open Issues: 83
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Memgraph Documentation
This repository contains the source files and various generators for the
Memgraph documentation available at
[memgraph.com/docs](https://memgraph.com/docs).
## :hammer_and_wrench: Run docs locally
To run the documentation website locally, you will need to install:
- [Node.js](https://nodejs.org/en/download/) version >= 16.0.0 or above (which
can be checked by running `node -v`). You can use
[nvm](https://github.com/nvm-sh/nvm) for managing multiple Node versions on a
single machine installed.
- [pnpm](https://pnpm.io/installation)
### Run the development server
To preview your changes as you edit the files, you can run a local development
server that will serve your website and reflect the latest changes.
First install `node` and `pnpm`. After that, clone this repository:
```
git clone https://github.com/memgraph/documentation.git
```
Change the working directory to the one of the cloned repository and install the dependencies:
```bash
pnpm i
```
Now, you can start the server:
```bash
pnpm dev
```
Open the URL [http://localhost:3000/docs](http://localhost:3000/docs) in your browser.
## :construction: Build
Install the dependencies:
```bash
pnpm i
```
Build the website:
```bash
pnpm build
```
Contents will be generated within the `/build` directory.
Test your build locally:
```bash
pnpm start
```
## :writing_hand: Contribute
We are grateful for any community contributions to the documentation, as they are
the best way of improving the overall user experience. If at any point you
believe that something is misleading, could be worded better, or is missing
additional information, then please feel free to make a pull request or report
an [issue](https://github.com/memgraph/documentation/issues).
### Contributing guide
If you want to change the documentation, create a new branch and make the
appropriate changes. Then, create a pull request to merge these changes into the
`main` branch.
The pull request should describe the changes it's proposing and all checks must
be completed.
Add an appropriate label to the PR, either `status: draft` if you are still
working on the PR, or `status: ready` if the PR is ready for review.
When the PR is reviewed and approved, the label will be changed to `status: ship
it` and merged into the main by the repo admins.
If the PR requires changes, the label will be changed to `status: change`.
Address the comments and change the documentation appropriately, then re-request
a review and change the label to `status: ready` again.