🦄PanDoc

The following documentation will describe the organization of our clone of the famous PANDOC software entirely developed in Haskell.

Documentation Chapters:

• Overview of the Arcade Project

• Getting set up

  • Project installation

  • Usage

• Technical documentation

  • Project organisation

  • Project Architecture

  • Doc on Modules && Classes

Note: This project was realized under the EPITECH computer science program with the intention of imparting expert-level skills in low-level computer paradigms. However, please be aware that this project cannot be implemented for commercial use. ;)

Overview of the Pandoc Project

The Pandoc project is designed to simplify the complex process of document conversion across various formats, mirroring the functionality of the renowned Pandoc software. This project focuses on the development of a versatile tool capable of transforming documents between different markup languages and file formats, ensuring seamless integration and compatibility across diverse platforms.

The primary goal of the project is to create a simplified version of Pandoc that supports conversion between three specific formats: XML, JSON, and Markdown. This functionality is particularly useful in environments where document exchange and format interoperability are crucial, such as academic publishing, web content management, and software documentation.

---

Key to the project is the implementation of a custom parsing library developed in Haskell, which is instrumental in interpreting and converting the document structures specific to each format. This library not only facilitates accurate document conversions but also serves as a critical learning tool in functional programming and compiler construction.

Security and efficiency are also paramount in the project's design. Although not directly handling sensitive information like passwords, the project emphasizes the importance of clean, maintainable code and robust error handling to prevent data corruption and ensure the reliability of the conversions.

The project leverages Haskell's strong type system and functional programming paradigms to ensure that the conversions are not only correct but also efficient in terms of computation and memory usage. This approach aligns with the best practices in software development, particularly in functional programming and system design.

Documentation Shortcuts:

🔵Getting Started🔵Technical Documentation