Skip to content
This repository has been archived by the owner on Jun 2, 2022. It is now read-only.

Latest commit

 

History

History
67 lines (44 loc) · 2.95 KB

README.md

File metadata and controls

67 lines (44 loc) · 2.95 KB
Raw

Conscriptor

Conscriptor

Preview of the Conscriptor app, displaying the editor and the preview window

A "Mac-assed" markdown editor, built in SwiftUI.

Conscriptor is a Markdown editor designed to make editing Markdown documents easier, more approachable, and faster.

License: MIT

Features

  • Live preview styled with GitHub's CSS so you can see what your document looks like in real-time.
  • Syntax highlighting to make styling stand out.
  • Customizable toolbar with quick access to common syntax to make editing approachable.
  • Keyboard shortcuts for common syntax to make editing quicker.
  • Inline HTML tags for adding in custom elements.
  • Templates to get you started quickly, with custom template creation and management to make writing common documents easy.
  • Insert tables pre-populated with placeholders to make writing tables quicker.
  • Insert image button to make adding images to documents simpler.
  • Quick Look integration that displays live previews of Markdown documents.

### Upcoming Additions

- Customization of keyboard shortcuts.

Getting Started

To setup Conscriptor for development...

  1. Install Xcode 13.2.1.
  2. Clone https://github.com/dbarsamian/conscriptor
  3. Open in Xcode.

Built with

  • Swift 5.5
  • SwiftUI
  • Xcode 13.2.1

Versions

Ver. # Release Date Notes
0.4 6 January 2022 Editor; Live Preview; Keyboard Shortcuts; Basic Templates
0.5 15 February 2022 Custom Templates; Link, Image, and Table Insertion
0.6 26 March 2022 Image, Link Insertion; Engine Improvement; Layout Improvement
0.7 4 April 2022 Quick Look extension, styling changes, new license
1.0 12 April 2022 Initial Release
1 June 2022 Open Source

Authors

License

This work is licensed under a MIT License. See LICENSE.md for more information.

Acknowledgements