Overview

Compiiile is a tool designed for rendering a folder containing markdown files, making it convenient to preview and search through markdown files effortlessly. The tool aims to provide users with a simple yet effective solution for previewing a whole folder, searching through content, creating slides, and producing a knowledge base while offering a user-friendly interface.

Features

• No Configuration Required: Works out of the box without the need to change files, supports image resolution, relative links, print-ready rendering, and offers light and dark themes.
• Cross-Platform Availability: Accessible on any device with static files deployment, making it convenient for viewing markdown files on computers, phones, or other devices.
• Quick File Navigation: Easily navigate files with a convenient navbar, and access links to the previous and next file with table of content generation.
• Slides Display: Display files as slides for presentation purposes.
• Full-Text Search: Enables quick search with content preview for efficient content discovery.
• Hot-Reload Preview: Content preview updates in real-time as you make edits for immediate feedback.
• MDX File Support: Allows users to add custom components to documentation using MDX files.
• Knowledge Base Functionality: Can be utilized as a knowledge base and supports symlinks for content reuse.
• Customizable: Offers customization options through environment variables or a config file to tailor the tool to individual preferences.

Installation

To install Compiiile, you can either install it globally or per-project. For a global installation, run the appropriate command based on your package manager (npm or yarn) in the terminal. For a per-project installation, navigate to the folder containing your markdown files and add Compiiile as a local command using yarn or npm. Additionally, Docker can be used for installation by following specific steps outlined in the documentation.

Summary

Compiiile provides a streamlined solution for rendering and previewing markdown files in a folder, offering a range of convenient features such as easy navigation, search functionality, slides display, and customizable options. With its emphasis on simplicity and ease of use, Compiiile aims to enhance the markdown documentation experience without the need for intricate configurations, making it a valuable tool for individuals relying on markdown for content creation and organization.