Overview

Octo is an innovative tool designed to streamline the process of generating static websites from text data and markdown files. It allows users to easily convert their written content into well-structured HTML, making it an invaluable resource for content creators, developers, and anyone looking to publish text online. With its straightforward installation and user-friendly commands, Octo can transform documents into web-ready formats quickly and efficiently.

What sets Octo apart is its versatility and ease of use. Whether you are working with individual text files or entire directories filled with markdown documents, Octo is equipped to handle your inputs and produce high-quality output. This makes it not just a tool for developers, but also a useful asset for writers and bloggers ready to reach a larger audience.

Features

Input Flexibility: Utilize the -i or --input flag to specify a single text file or an entire directory to process. Works seamlessly with paths containing spaces when enclosed in quotes.
File Input: Effortlessly convert the contents of a specified text file into an HTML file with a simple command.
Directory Input: Octo can scan through entire directories, locating and converting all nested text files into HTML, which saves time and effort.
Customizable Output: Use the -o or --output flag to define where the generated HTML files should be saved. If no output path is specified, it defaults to './dist'.
Markdown Support: Input markdown files with appropriate formatting, and Octo will convert them into HTML tags seamlessly, preserving the original structure.
Recursive Searching: When you input a directory, Octo recursively processes all child directories, ensuring all text and markdown files are converted, no matter how deeply nested.
Cross-Platform Compatibility: Install Octo easily on Mac, Linux, and Windows systems, making it accessible to a wide range of users.
Contribution Opportunities: For those interested in enhancing the tool, Octo welcomes contributions, providing a chance to be a part of its development.

Luigizaccagnini

Octo