https://github.com/tywil04/parchment

A minimal minimal text editor written using web technologies for Windows, Linux and MacOS
https://github.com/tywil04/parchment

cross-platform css gpl3 html javascript linux macos minimal notepad rust solidjs tailwind-css tailwindcss tauri text windows

Last synced: 3 months ago
JSON representation

A minimal minimal text editor written using web technologies for Windows, Linux and MacOS

• Host: GitHub
• URL: https://github.com/tywil04/parchment
• Owner: tywil04
• License: gpl-3.0
• Created: 2022-05-30T20:16:08.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-01T19:42:47.000Z (8 months ago)
• Last Synced: 2024-05-31T15:19:13.813Z (5 months ago)
• Topics: cross-platform, css, gpl3, html, javascript, linux, macos, minimal, notepad, rust, solidjs, tailwind-css, tailwindcss, tauri, text, windows
• Language: JavaScript
• Homepage:
• Size: 3.06 MB
• Stars: 13
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-tauri - Parchment - Simple local-only cross-platform text editor with basic markdown support. (Applications / Office & Writing)

README

        
# Parchment

Parchment is a minimal text editor written using web technologies for Windows, Linux and MacOS.

Special thanks to the following libraries and assets:

- [SolidJS](https://www.solidjs.com/) - for a very performant and lightweight javascript framework

- [TailwindCSS](https://tailwindcss.com/) to allow for simple styling of the application

- [Tauri](https://tauri.app/) - a rust wrapper that allows you to create fast and secure desktop applications using web technologies

- Uses this [Notepad](https://www.flaticon.com/free-icon/notebook_346081?related_id=346081&origin=search) icon from Flaticon (free to use for personal and commercial purposes) for the taskbar icon.

- [Tabler Icons](https://tablericons.com/) for the few icons used within this application.

This app should work on Windows, MacOS and Linux however it only has been tested on Windows. 

# Usage

Head to the releases page to download pre-built executables. If you want you can build it, please follow the building section below.

# Building

Before you build, you need to have everything required installed follow this [guide](https://tauri.app/v1/guides/getting-started/prerequisites#installing) to install Tauri and its dependencies. 

Once everything needed is installed, building this app is very simple:

```

git clone https://github.com/tywil04/parchment.git

cd parchment

npm install

npm run tauri build

```

Once the build has been completed, you will find the executables in src-tauri/target/release/bundle

# Screenshots

![Parchment Text Editor](/parchment.webp)