chore: Sync package version v1.15.1
This commit is contained in:
@@ -1,50 +1,63 @@
|
||||
---
|
||||
title: Introduction
|
||||
description: This section provides an overview of DocuBook.
|
||||
date: 29-11-2024
|
||||
image: example-img.png
|
||||
title : Introduction
|
||||
description : overview or synopsis of a project
|
||||
date : 10-12-2024
|
||||
---
|
||||
|
||||
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.
|
||||
## Heading 2
|
||||
|
||||
## Open Source Philosophy
|
||||
this is regular text written in markdown format with `inline code`, **bold**, and *italic*
|
||||
|
||||
DocuBook is proudly **open-source**! 🎉 We believe in creating an accessible, collaborative platform that thrives on community contributions.
|
||||
### Heading 3
|
||||
|
||||
<Note title="Contribute">
|
||||
Interested in helping us improve? Check out our [GitHub
|
||||
repository](https://github.com/DocuBook/docubook) to get started! From
|
||||
feature suggestions to bug fixes, all contributions are welcome.
|
||||
example of ordered list format :
|
||||
|
||||
- list one
|
||||
- sub list
|
||||
- list two
|
||||
- list three
|
||||
|
||||
#### Heading 4
|
||||
|
||||
Below is an example of how to write a code block :
|
||||
|
||||
````plaintext
|
||||
```javascript:main.js showLineNumbers {3-4}
|
||||
function isRocketAboutToCrash() {
|
||||
// Check if the rocket is stable
|
||||
if (!isStable()) {
|
||||
NoCrash(); // Prevent the crash
|
||||
}
|
||||
}
|
||||
```
|
||||
````
|
||||
|
||||
example note :
|
||||
```plaintext
|
||||
<Note type="note" title="Note">
|
||||
This is a general note to convey information to the user.
|
||||
</Note>
|
||||
```
|
||||
|
||||
## Project Overview
|
||||
displaying an image in markdown format :
|
||||
|
||||
**DocuBook** is more than just a documentation template. It's a **complete toolkit** designed for modern web development. Key features include:
|
||||
```plaintext
|
||||

|
||||
```
|
||||
|
||||
- **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.
|
||||
render as :
|
||||

|
||||
|
||||
### Key Features
|
||||
For a complete guide on using markdown content in DocuBook, please refer to the [Components](https://docubook.pro/docs/components) page.
|
||||
|
||||
| **Feature** | **Description** |
|
||||
| ------------------------------- | ----------------------------------------------------- |
|
||||
| MDX Support | Write interactive documentation with MDX. |
|
||||
| Nested Pages | Organize content in a nested, hierarchical structure. |
|
||||
| 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.
|
||||
<Note type="warning" title="Warning">
|
||||
every page that is indexed in a folder will have an `index.mdx` file with metadata :
|
||||
```plaintext
|
||||
---
|
||||
title : Introduction
|
||||
description : overview or synopsis of a project
|
||||
date : 10-12-2024
|
||||
image : example-img.png
|
||||
---
|
||||
```
|
||||
</Note>
|
||||
Reference in New Issue
Block a user