Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/flancian/garden/llms.txt

Use this file to discover all available pages before exploring further.

Publishing your digital garden to the Agora means the Agora can pull your notes, render them alongside other contributors’ writing, and interlink them into the shared knowledge graph — all without the Agora hosting your data. You keep full ownership of your notes; you just make them publicly readable, and the Agora does the rest.

​
What you need before you start

A Git host account

GitHub and GitLab are the two most common options. Create a free account at github.com or gitlab.com if you don’t have one.

Git installed locally

Git is pre-installed on most Linux and macOS systems. If you need it, download it from git-scm.com.

Notes in a supported format

Markdown with wikilinks is the default format. Plain text also works. Other formats (Roam, Org Mode) are supported — see choosing an editor.

A public repository

The Agora pulls from publicly accessible URLs. Your repository must be set to public visibility on your Git host.

​
Create and structure your garden repository

1

Create a new repository

On GitHub, click New repository. Give it a name (for example, garden or notes), set visibility to Public, and create it. On GitLab the process is identical under New project → Create blank project.
You can also use an existing repository that already contains your notes. You don’t need to start from scratch.
2

Organise your notes as Markdown files

The Agora expects your notes as .md files. File names become node slugs — a file named climate-change.md will appear at the node [[climate change]]. Subdirectories are supported; the Agora flattens paths into node names by default.A minimal garden looks like this:
my-garden/
├── index.md
├── climate-change.md
├── reading-list.md
└── projects/
    └── open-source.md
3

Write notes with wikilinks

Use double-bracket syntax to link to other nodes. These links work across gardens — if another contributor has a note on the same topic, it will appear in the same node.
# Climate change

I've been reading about [[renewable energy]] and [[carbon budgets]] lately.

#push [[reading list]]
- Drawdown by Paul Hawken
See wikilinks and formatting for the full syntax reference.
4

Push your notes to the remote

If this is a new repository, initialise it and push:
git init
git add .
git commit -m "initial garden commit"
git remote add origin https://github.com/YOUR_USERNAME/YOUR_REPO.git
git push -u origin main
If you are connecting an existing repository, a normal git push is all you need.

​
Register your garden with the Agora

The Agora learns about new gardens through a file called gardens.yaml in the Agora repository. You add your garden by opening a pull request.
1

Fork the Agora repository

Go to github.com/flancian/agora and click Fork. This creates a copy of the repository under your GitHub account.
2

Edit gardens.yaml

Open gardens.yaml in your fork. Each entry in the file describes one garden. Add a new entry at the end of the list following the pattern already established in the file.A typical entry looks like this:
- url: https://github.com/YOUR_USERNAME/YOUR_REPO
  user: your-agora-username
  format: markdown
FieldDescription
urlThe public URL of your Git repository (GitHub, GitLab, or any public host).
userYour desired Agora username. This will appear on your nodes.
formatContent format. Use markdown unless you know you need something different.
By submitting a pull request you confirm that you agree to the Agora’s contract, maintained by the @agora system account. Only that contract is required; other users’ contracts are optional.
3

Open a pull request

Commit your change to your fork and open a pull request against the main Agora repository. Include a short description in the PR body — for example, a link to your garden and your desired username.A maintainer will review and merge your PR. You can also reach out directly:

​
What happens after your garden is registered

Once your entry is merged into gardens.yaml, the Agora will begin pulling your notes on its next sync cycle. Your nodes will become accessible at https://anagora.org/YOUR_NODE_NAME, combined with notes from every other contributor who has written about the same topic.
The Agora syncs periodically. In practice most gardens appear within a few hours of the PR being merged. If your notes haven’t appeared after 24 hours, reach out via signup@anagora.org.
No. The Agora pulls from public URLs. Your repository must be publicly readable. The Agora does not host or store your notes — it only renders them in context.
Markdown with wikilinks is the primary supported format. Roam Research exports, Org Mode files, and plain text are also supported to varying degrees. If you use a different system, email signup@anagora.org to discuss your use case.
Yes. To update your garden URL or username, open another PR editing gardens.yaml. To remove your garden, open a PR deleting your entry. Your notes will stop appearing in the Agora after the next sync.

​
Optional: add an agora.yaml to your garden

You can include an agora.yaml file in the root of your repository to configure how the Agora integrates your garden. This is optional for basic participation but enables advanced features like bridge configuration and per-user actions. See configure your Agora settings with agora.yaml for details.

Build docs developers (and LLMs) love

Get started for freeTalk to us