This is the source for Santiment Knowledge Base site
We use pnpm and Node v22. To run the app locally:
pnpm install
pnpm dev
This is going to run the app on port 3000, so localhost:3000 should be accessible.
We use MDX (.mdx) for all content. The routing is file-system based and located in src/content/docs/ (or src/docs/).
- To create a page at
academy.santiment.net/test, addsrc/docs/[section]/test.mdx. - Images should be placed in the same folder as the article and referenced relatively.
The sidebar is generated automatically.
- Visibility: All files are visible by default.
- Hiding: To hide an article from the sidebar, set
sidebar.hidden: truein the frontmatter. - Ordering: Use
sidebar.order: [number]to control the position in the list.
- Available custom components:
<Resource title="title">Markdown Content</Resource>,<Notebox type="note|pin|hand">Markdown Content</Notebox> - Disable image automatic bordering: Append
noborderto image alt, eg:
To update the llms.txt file (LLM-readable index of all documentation):
pip install pyyaml
python scripts/generate_llms_txt.py
A metadata block (Frontmatter) should be in YAML notation directly at the top of the MDX file.
- title: Required.
- description: Required.
- datePublished: Required.
- dateModified: Update this field when you refactor the article.
- author: Preferably full name.
Example:
---
title: Daily active addresses metric
description: The number of distinct addresses that participated in a transfer.
author: Tzanko Matev
dateModified: 2025-12-21
datePublished: 2025-12-21
sidebar:
hidden: false
---
## Some title in article
The number of distinct addresses that ...h2 (##) headings will be used to generate the fast navigation (Table of Contents) on the right.
To deploy updates to the production environment, follow these steps:
- Create a pull request (e.g. "Main and Production branches sync") to merge changes from the
maininto theproductionbranch - https://github.com/santiment/academy/compare/production...main - Merge the pull request to deploy the updates to the production environment.
We're hiring developers, support people, and product managers all the time. Please check our open positions
Join thousands of members worldwide in our community server.
Any other questions, reach out to us at support@santiment.net. We’d be happy to help!