• About
• Installation
• Building
• Tech Stack
• Features
• Showcase
• License

🪶 Scribe

Scribe is a desktop application built with C# using WPF and .NET 8. It enables users to create and edit documents using a custom markup language, with complete rendering of the formatted text.

A detailed tutorial for Scribe's markup language is available at Tutorial.pdf.

Installation

Requirements:

• Windows 10/11

You can download the application from the GitHub releases page.

After downloading, run the Scribe.exe file. Ensure that the executable is always located in the same directory as the Configurations and Database folders.

Building

Requirements:

• .NET 8 SDK
• Windows 10/11

To build the project from the source code, clone this repository to your local environment or download the project files:

git clone https://github.com/enzzoMs/Scribe.git

Navigate to the main project directory:

cd ./Scribe/Scribe.UI

Run the following command to publish the application:

dotnet publish -r win-x64 -o <OUTPUT_DIRECTORY>

The resulting files will be placed in the specified directory (<OUTPUT_DIRECTORY>), ready to run as described in the previous section.

Tech Stack

• C# + .NET 8

• WPF + MVVM Architecture

• EF Core + SQLite

• xUnit + NSubstitute

Additional Libraries:

• AvalonEdit - A WPF-based text editor component.

• PDFsharp - An open source library for creating and processing PDF documents.

Features

• Folders and Documents: Create and organize documents into folders for easier access and management.

• Tags: Mark related content with tags to simplify searching and categorization.

• Markup Language: Utilize a custom markup language for formatting documents with headers, lists, tables, bold, italics, and more.

• Save and Load Documents: Save and load documents in JSON format.

• PDF Export: Export rendered documents as PDF files.

• Light and Dark Themes: Toggle between light and dark modes.

Showcase

License

This project is distributed under the MIT License. Check the LICENSE file for more details.