52 lines
2.9 KiB
Plaintext
52 lines
2.9 KiB
Plaintext
---
|
||
title: Introduction
|
||
description: This section provides an overview of DocuBook.
|
||
date: 29-11-2024
|
||
image: example-img.png
|
||
---
|
||
|
||
Welcome to **DocuBook**! This template provides a modern, flexible, and user-friendly foundation for creating engaging documentation. Whether you're building a knowledge base, project docs, or a personal blog, DocuBook makes it easy to set up and scale.
|
||
|
||
## Open Source Philosophy
|
||
|
||
DocuBook is proudly **open-source**! 🎉 We believe in creating an accessible, collaborative platform that thrives on community contributions.
|
||
|
||
<Note title="Contribute">
|
||
Interested in helping us improve? Check out our [GitHub
|
||
repository](https://github.com/mywildancloud/docubook) to get started! From
|
||
feature suggestions to bug fixes, all contributions are welcome.
|
||
</Note>
|
||
|
||
## Project Overview
|
||
|
||
**DocuBook** is more than just a documentation template. It's a **complete toolkit** designed for modern web development. Key features include:
|
||
|
||
- **Markdown & MDX Support:** Easily write documentation in Markdown, with the option to include interactive components via MDX.
|
||
- **Customizable Themes:** Designed with a minimalist ShadCN-inspired theme that’s easy to style.
|
||
- **SEO-Optimized:** Each page is SEO-ready, ensuring search engines can find and rank your content.
|
||
- **Interactive Code Blocks:** Beautifully styled, language-specific code blocks for an enhanced reading experience.
|
||
|
||
### Key Features
|
||
|
||
| **Feature** | **Description** |
|
||
| ------------------------------- | ----------------------------------------------------- |
|
||
| MDX Support | Write interactive documentation with MDX. |
|
||
| Nested Pages | Organize content in a nested, hierarchical structure. |
|
||
| Blog Section | Include a dedicated blog section. |
|
||
| Pagination | Split content across multiple pages. |
|
||
| Syntax Highlighting | Highlight code for better readability. |
|
||
| Code Line Highlighting & Titles | Highlight specific lines with descriptive titles. |
|
||
| Interactive Code Blocks | Language-specific and interactive code display. |
|
||
| Custom Markdown Components | Embed custom, reusable components in your docs. |
|
||
| Static Site Generation | Generate a static, high-performance site. |
|
||
| SEO-Optimized | Structured for optimal search engine indexing. |
|
||
|
||
## Technology & Libraries
|
||
|
||
DocuBook leverages cutting-edge technologies to ensure performance and flexibility:
|
||
|
||
- **Next.js 14** - The powerful React framework optimized for production.
|
||
- **Tailwind CSS** - Utility-first styling for quick, clean designs.
|
||
- **Shadcn-UI** - Elegant, accessible components for a polished look.
|
||
- **next-mdx-remote** - Enables MDX support for dynamic, interactive Markdown content.
|