Navigation
Effective navigation helps users find information quickly and understand the structure of your documentation.
Internal Links
Link between documentation pages using relative URLs.
Basic Syntax
[Link Text](page-name)
[Link Text](folder/page-name)
Examples
# See Also
- [Getting Started](getting-started)
- [Features Overview](features)
- [API Reference](api/authentication)
- [Troubleshooting Guide](guides/troubleshooting)
Rendered:
Linking to Homepage
[Return to Home](index)
[Documentation Home](/)
Nested Page Links
[Installation Guide](guides/installation)
[API Endpoints](api/endpoints/users)
[Advanced Configuration](tutorials/advanced/configuration)
External Links
Link to external resources with full URLs:
[Laravel Documentation](https://laravel.com/docs)
[GitHub Repository](https://github.com/username/repo)
[Official Website](https://example.com)
Rendered:
Breadcrumbs
Breadcrumbs are automatically generated from the URL structure.
Examples
| Page URL | Breadcrumb |
|---|---|
/docs |
Home |
/docs/getting-started |
Home / Getting Started |
/docs/api/authentication |
Home / Api / Authentication |
/docs/guides/advanced/config |
Home / Guides / Advanced / Config |
Table of Contents
The sidebar TOC is auto-generated from H2 and H3 headers.
Good Header Structure
# Page Title
## Main Section 1
Content here...
### Subsection 1.1
More details...
### Subsection 1.2
More details...
## Main Section 2
Content here...
### Subsection 2.1
Details...
TOC will show:
- Main Section 1
- Subsection 1.1
- Subsection 1.2
- Main Section 2
- Subsection 2.1
Optimizing for TOC
Good:
## Installation
## Configuration
## Usage
## Troubleshooting
Avoid:
## How do I install this application and get it running?
## Configuring all the environment variables and settings
## Using the application for daily tasks
Keep headers concise for better TOC readability.
Navigation Lists
Create navigation sections within pages:
Simple List
## Documentation Sections
- [Getting Started](getting-started)
- [User Guide](user-guide)
- [API Reference](api-reference)
- [FAQ](faq)
Categorized Navigation
## Documentation
### For End Users
- [Quick Start](quick-start)
- [Basic Tasks](basic-tasks)
- [Settings](settings)
### For Developers
- [API Overview](api/overview)
- [Authentication](api/authentication)
- [Webhooks](api/webhooks)
### For Administrators
- [Installation](admin/installation)
- [Configuration](admin/configuration)
- [Maintenance](admin/maintenance)
With Descriptions
## Popular Topics
**[Getting Started](getting-started)**
New to the platform? Start here for installation and setup.
**[API Documentation](api/overview)**
Complete reference for integrating with our API.
**[Troubleshooting](troubleshooting)**
Common issues and their solutions.
**[Best Practices](best-practices)**
Recommended patterns and techniques.
Navigation Patterns
Sequential Navigation
For tutorials and step-by-step guides:
# Step 3: Configure Database
...content...
---
**Previous:** [Step 2: Install Dependencies](step-2-install)
**Next:** [Step 4: Run Migrations](step-4-migrations)
Hub and Spoke
Create index pages that link to related content:
File: resources/docs/api/index.md
# API Documentation
## Getting Started
- [Authentication](api/authentication)
- [Rate Limiting](api/rate-limiting)
- [Error Handling](api/errors)
## Endpoints
- [Users](api/endpoints/users)
- [Projects](api/endpoints/projects)
- [Webhooks](api/endpoints/webhooks)
## Examples
- [cURL Examples](api/examples/curl)
- [JavaScript Examples](api/examples/javascript)
- [PHP Examples](api/examples/php)
Related Content
At the end of pages:
---
## Related Topics
- [User Authentication](authentication)
- [Authorization & Permissions](authorization)
- [Security Best Practices](security)
## Further Reading
- [API Reference](api/overview)
- [Integration Guide](integrations)
Anchor Links
Link to specific sections within pages:
Jump to:
- [Installation](#installation)
- [Configuration](#configuration)
- [Usage](#usage)
## Installation
...
## Configuration
...
Anchor Examples
| Header | Anchor Link |
|---|---|
## Installation |
#installation |
## Getting Started |
#getting-started |
### API Keys |
#api-keys |
## FAQ |
#faq |
Navigation Best Practices
1. Consistent Structure
Maintain similar navigation on related pages:
<!-- All API pages -->
## Related API Docs
- [Authentication](api/authentication)
- [Rate Limits](api/rate-limits)
- [Error Codes](api/errors)
2. Descriptive Link Text
Good:
[View installation guide](installation)
[Check system requirements](requirements)
[Read API documentation](api/overview)
Avoid:
[Click here](installation)
[More info](requirements)
[Read more](api/overview)
3. Logical Grouping
Group related links together:
## Administration
### Setup
- [Installation](admin/installation)
- [Configuration](admin/configuration)
- [Database Setup](admin/database)
### Maintenance
- [Backups](admin/backups)
- [Updates](admin/updates)
- [Monitoring](admin/monitoring)
4. Breadcrumb-Friendly URLs
Use descriptive paths that make sense in breadcrumbs:
Good:
/docs/guides/installation
/docs/api/authentication
/docs/tutorials/first-app
Avoid:
/docs/guide1
/docs/pg2
/docs/tut-app
5. Landing Pages
Create overview pages for major sections:
<!-- resources/docs/api/index.md -->
# API Documentation
Welcome to the API documentation. Our API provides...
## Quick Links
- [Authentication](api/authentication)
- [Endpoints](api/endpoints)
- [Rate Limits](api/rate-limits)
## Getting Started
...
Navigation for Different Types
Tutorial Navigation
# Build Your First App - Part 2
← [Part 1: Setup](tutorial-part-1) | [Part 3: Database →](tutorial-part-3)
---
In this part, we'll...
---
← [Part 1: Setup](tutorial-part-1) | [Part 3: Database →](tutorial-part-3)
Reference Navigation
# API Endpoint: Create User
[← Back to API Reference](api/overview)
**Related Endpoints:**
- [Get User](api/get-user)
- [Update User](api/update-user)
- [Delete User](api/delete-user)
Concept Navigation
# Understanding Authentication
**Prerequisites:**
- [Basic Concepts](concepts/basics)
- [User Management](user-management)
**Next Steps:**
- [Authorization](authorization)
- [Security Best Practices](security)
Mobile Navigation
# Long Article Title
**Jump to section:**
- [Introduction](#introduction)
- [Setup](#setup)
- [Usage](#usage)
- [FAQ](#faq)
## Introduction
...
Examples Repository
Documentation Hub Page
# Documentation
## Getting Started
New to our platform? Start here.
- [Quick Start](quick-start) - Get up and running in 5 minutes
- [Installation](installation) - Detailed setup instructions
- [Configuration](configuration) - Configure your environment
## User Guides
Learn how to use key features.
- [Dashboard](guides/dashboard) - Navigate the interface
- [Projects](guides/projects) - Create and manage projects
- [Teams](guides/teams) - Collaborate with your team
- [Reports](guides/reports) - Generate and export reports
## API Reference
Integrate with our platform.
- [API Overview](api/overview) - Authentication and basics
- [Endpoints](api/endpoints) - Complete API reference
- [Webhooks](api/webhooks) - Real-time event notifications
- [SDKs](api/sdks) - Official libraries and SDKs
## Support
Get help when you need it.
- [FAQ](faq) - Frequently asked questions
- [Troubleshooting](troubleshooting) - Common issues
- [Contact Support](support) - Reach our team
- [System Status](https://status.example.com) ↗