Getting Started

Introduction 

Learn the basics of DevDocs and how to get started with your first project.

DevDocs is a powerful documentation framework designed for developers who want to create beautiful, functional documentation sites with minimal effort. It combines the flexibility of modern web technologies with the simplicity of markdown-based content.

Installation

You can install DevDocs using your preferred package manager:

# Using npm
npm install devdocs-sdk

# Using yarn
yarn add devdocs-sdk

# Using pnpm
pnpm add devdocs-sdk

Quick Start

After installation, create a new configuration file in your project root:

import { DevDocs } from 'devdocs-sdk';

const docs = new DevDocs({
  title: 'My Documentation',
  theme: 'default',
  navigation: {
    sidebar: true,
    search: true
  }
});

docs.init();