https://github.com/kaishin/markoff

A lightweight Markdown (CommonMark) previewer for macOS.
https://github.com/kaishin/markoff

Last synced: about 1 month ago
JSON representation

A lightweight Markdown (CommonMark) previewer for macOS.

• Host: GitHub
• URL: https://github.com/kaishin/markoff
• Owner: kaishin
• License: isc
• Created: 2015-09-01T18:47:19.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2020-10-13T10:03:35.000Z (about 4 years ago)
• Last Synced: 2024-10-30T08:18:57.090Z (about 1 month ago)
• Language: Swift
• Homepage:
• Size: 2.16 MB
• Stars: 793
• Watchers: 20
• Forks: 43
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-tca - markoff - A lightweight Markdown (CommonMark) previewer for macOS.

README

        
# Markoff 2 ![Platform](https://img.shields.io/badge/platform-macOS%2011-lightgrey.svg) ![Platform](https://img.shields.io/badge/license-ISC-lightgrey.svg)

A lightweight CommonMark previewer for macOS Big Sur and later.

- Uses [SwiftDoc](https://github.com/SwiftDocOrg)'s [CommonMark](https://github.com/SwiftDocOrg/CommonMark) implementation for transforming the markdown into HTML.

- Uses the [Composable Architecture](https://github.com/pointfreeco/swift-composable-architecture).

- Uses the new SwiftUI lifecycle for document-based apps.

- Auto-reloads the preview whenever the original file is saved. Depending on

your editor, you might be able to set up auto-save to get an always up-to-date

preview without manually saving.

- Shows basic metadata such word and character count.

### Left to Do for 2.0

- [ ] Code syntax highlighting.

- [ ] Select default editor.

- [ ] Add printing support.

- [ ] Add addtional CSS styles.

## Setup

1. Open the project in Xcode 12 or later.

2. There is no step 2.

If you use another text editor, follow your usual SPM workflow.

## Previous Versions

The previous versions of the app are in the `markoff-1` and `markoff-2` branches.

- The `markoff-1` branch is deprecated.

- The `markoff-2` branch is compatible with Catalina, and will get some minor patches in the future. 

All future development will take place in the `main` branch.

## License

See LICENSE file.

## Author

[Reda Lemeden](https://redalemeden.com)

[LICENSE]: https://raw.githubusercontent.com/kaishin/Markoff/master/LICENSE