Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
# Dependencies
/node_modules
node_modules/

# Production
/build

# Generated files
.docusaurus
.cache-loader
dist/
.astro/

# Misc
.DS_Store
.env
.env.local
.env.development.local
.env.test.local
Expand All @@ -18,3 +16,4 @@
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
51 changes: 21 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,32 @@
# Website
# Mintlayer Docs

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
Official documentation for [Mintlayer](https://www.mintlayer.org), built with [Astro Starlight](https://starlight.astro.build).

### Installation
## Local development

```bash
npm install
npm run dev # http://localhost:4321/
npm run build # production build to ./dist
npm run preview # preview production build
```
$ yarn
```

### Local Development

```
$ yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

Using SSH:
## Project structure

```
$ USE_SSH=true yarn deploy
src/
├── assets/ # logo and images
├── components/ # custom Astro components (hero, cards)
├── content/docs/ # documentation pages (.md / .mdx)
└── styles/ # design system CSS
astro.config.mjs # Starlight config and sidebar
public/ # static assets
```

Not using SSH:
## Contents

```
$ GIT_USER=<Your GitHub username> yarn deploy
```
- **Build** — Mojito Inject, JavaScript SDK, MCP
- **Guides** — token issuance, bridge API, Trezor firmware
- **Whitepaper** — architecture, wallet, tokenization, DeFi, DEX, tokenomics

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
> If you deploy to GitHub Pages under a project path, set `base: '/mintlayer-docs/'` in `astro.config.mjs`.
122 changes: 122 additions & 0 deletions astro.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
// @ts-check
import { defineConfig } from 'astro/config';
import mermaid from 'astro-mermaid';
import starlight from '@astrojs/starlight';

export default defineConfig({
site: 'https://docs.mintlayer.org',
integrations: [
mermaid({
autoTheme: true,
enableLog: false,
mermaidConfig: {
theme: 'dark',
flowchart: { curve: 'basis', nodeSpacing: 32, rankSpacing: 48 },
themeVariables: {
fontFamily: 'DM Sans, Inter, ui-sans-serif, system-ui, sans-serif',
fontSize: '13px',
primaryColor: '#18181b',
primaryTextColor: '#e4e4e7',
primaryBorderColor: '#3f3f46',
lineColor: '#52525b',
secondaryColor: '#27272a',
tertiaryColor: '#1c1c1e',
},
},
}),
starlight({
components: {
SocialIcons: './src/components/SocialIcons.astro',
},
title: 'Mintlayer Docs',
description: 'Official documentation for the Mintlayer blockchain platform.',
logo: {
src: './src/assets/mintlayer-logo.svg',
alt: 'Mintlayer',
replacesTitle: true,
},
titleDelimiter: '|',
defaultLocale: 'root',
social: [
{ icon: 'github', label: 'GitHub', href: 'https://github.com/mintlayer' },
{ icon: 'x.com', label: 'X', href: 'https://twitter.com/mintlayer' },
{ icon: 'discord', label: 'Discord', href: 'https://discord.gg/gkZ4h8McBT' },
{ icon: 'external', label: 'mintlayer.org', href: 'https://www.mintlayer.org' },
],
customCss: ['./src/styles/mintlayer.css'],
head: [
{ tag: 'link', attrs: { rel: 'preconnect', href: 'https://fonts.googleapis.com' } },
{
tag: 'link',
attrs: {
rel: 'stylesheet',
href: 'https://fonts.googleapis.com/css2?family=DM+Sans:ital,opsz,wght@0,9..40,300;0,9..40,400;0,9..40,500;0,9..40,600;0,9..40,700;1,9..40,400&family=JetBrains+Mono:wght@400;500;600&display=swap',
},
},
{ tag: 'meta', attrs: { property: 'og:type', content: 'website' } },
{ tag: 'meta', attrs: { property: 'og:site_name', content: 'Mintlayer Docs' } },
{ tag: 'meta', attrs: { property: 'og:title', content: 'Mintlayer Docs' } },
{
tag: 'meta',
attrs: {
property: 'og:description',
content:
'Official documentation for Mintlayer — whitepaper, SDKs, Mojito, bridge, and developer guides.',
},
},
{ tag: 'meta', attrs: { property: 'og:url', content: 'https://docs.mintlayer.org' } },
{ tag: 'meta', attrs: { name: 'twitter:card', content: 'summary_large_image' } },
{ tag: 'meta', attrs: { name: 'twitter:site', content: '@mintlayer' } },
{ tag: 'meta', attrs: { name: 'twitter:title', content: 'Mintlayer Docs' } },
{
tag: 'meta',
attrs: {
name: 'twitter:description',
content:
'Official documentation for Mintlayer — whitepaper, SDKs, Mojito, bridge, and developer guides.',
},
},
],
sidebar: [
{
label: 'Start Here',
collapsed: false,
items: [
{ label: 'Home', slug: '' },
{ label: 'Introduction', slug: 'intro' },
],
},
{
label: 'Build',
collapsed: false,
items: [
{ label: 'Mojito Inject', slug: 'mojito-inject/getting-started' },
{ label: 'JavaScript SDK', slug: 'javascript-sdk/getting-started' },
{ label: 'MCP', slug: 'mcp/getting-started' },
],
},
{
label: 'Guides',
collapsed: false,
items: [
{ label: 'Issue a New Token', slug: 'guides/issue-new-token' },
{ label: 'Bridge API', slug: 'bridge' },
{ label: 'Trezor Firmware', slug: 'trezor/1-build-firmware' },
],
},
{
label: 'Whitepaper',
collapsed: false,
items: [
{ label: 'Blockchain Architecture', slug: 'whitepaper/1-blockchain-architecture' },
{ label: 'Mintlayer Wallet', slug: 'whitepaper/2-mintlayer-wallet' },
{ label: 'Tokenization Standard', slug: 'whitepaper/3-tokenization-standard' },
{ label: 'Decentralized Finance', slug: 'whitepaper/4-decentralized-finance-defi' },
{ label: 'Decentralized Exchange', slug: 'whitepaper/5-decentralized-exchange-dex' },
{ label: 'Token and Public Sale', slug: 'whitepaper/6-token-and-public-sale' },
],
},
],
}),
],
});
7 changes: 0 additions & 7 deletions docs/bridge/_category_.json

This file was deleted.

7 changes: 0 additions & 7 deletions docs/guides/_category_.json

This file was deleted.

6 changes: 0 additions & 6 deletions docs/intro.md

This file was deleted.

7 changes: 0 additions & 7 deletions docs/javascript-sdk/_category_.json

This file was deleted.

7 changes: 0 additions & 7 deletions docs/mcp/_category_.json

This file was deleted.

10 changes: 0 additions & 10 deletions docs/mojito-inject/_category_.json

This file was deleted.

7 changes: 0 additions & 7 deletions docs/trezor/_category_.json

This file was deleted.

7 changes: 0 additions & 7 deletions docs/whitepaper/_category_.json

This file was deleted.

Loading