Getting Started

This guide will help you get the ByteLand Docs Template up and running in minutes.

Prerequisites

Before you begin, make sure you have the following installed:

• Node.js 18.17 or later
• npm, pnpm, or yarn package manager

Installation

1. Clone the Repository

git clone https://github.com/ByteLandTechnology/docs.byteland.app.git my-docs
cd my-docs

2. Install Dependencies

npm install

3. Start Development Server

npm run dev

4. Open in Browser

Visit http://localhost:3000  to see your documentation site.

Quick Customization

Update Site Title

Edit app/layout.tsx and change the navbar logo text:

<span className="font-bold text-2xl tracking-tight text-gradient-tri">
  Your Project Name
</span>

Update Metadata

In the same file, update the metadata:

export const metadata: Metadata = {
  title: "Your Project Docs",
  description: "Documentation for Your Project",
};

Replace Logos

Replace the following files in the public/ directory:

• openland.svg - Your project logo (appears in navbar)
• byteland.svg - ByteLand logo (can be kept or replaced)

Next Steps

• Project Structure - Understand how files are organized
• Customization - Learn how to customize the template
• Adding Pages - Add new documentation pages