Skip to content

Latest commit

 

History

History
73 lines (51 loc) · 1.62 KB

README.md

File metadata and controls

73 lines (51 loc) · 1.62 KB

SimpleNS Documentation

Built with Fumadocs Next.js

The official documentation website for SimpleNS - a self-hosted notification orchestration engine.

🌐 Live Site: https://simplens.in

📚 Documentation Structure

content/docs/
├── core/           # Core system documentation
│   ├── getting-started.mdx
│   ├── self-hosting.mdx
│   ├── architecture.mdx
│   ├── configuration.mdx
│   └── ...
├── plugins/        # Plugin ecosystem
│   ├── index.mdx
│   └── official-plugins/
└── sdk/            # Plugin SDK reference
    ├── building-plugin.mdx
    └── ...

🚀 Getting Started

Prerequisites

  • Node.js 18+
  • npm or pnpm

Installation

# Clone the repository
git clone https://github.com/SimpleNotificationSystem/simplens-docs.git
cd simplens-docs

# Install dependencies
npm install

# Start development server
npm run dev

Open http://localhost:3000 to view the documentation.

Build for Production

npm run build
npm run start

🛠️ Tech Stack

  • Framework: Next.js 16 with App Router
  • Documentation: Fumadocs
  • Styling: Tailwind CSS
  • Content: MDX with custom components

📄 License

This documentation is part of the SimpleNS project.