Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gichukipaul/citadel
Convert Markdown to HTML effortlessly with our user-friendly Mac App. Enjoy live previews, and a responsive design. Download now and seamlessly transition between Markdown and HTML for a smoother document editing experience!
https://github.com/gichukipaul/citadel
macos markdown markdown-editor swift swiftui
Last synced: about 8 hours ago
JSON representation
Convert Markdown to HTML effortlessly with our user-friendly Mac App. Enjoy live previews, and a responsive design. Download now and seamlessly transition between Markdown and HTML for a smoother document editing experience!
- Host: GitHub
- URL: https://github.com/gichukipaul/citadel
- Owner: gichukipaul
- License: mit
- Created: 2024-01-13T22:16:25.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-07-31T21:22:25.000Z (about 2 months ago)
- Last Synced: 2024-09-24T21:14:59.972Z (about 13 hours ago)
- Topics: macos, markdown, markdown-editor, swift, swiftui
- Language: Swift
- Homepage: https://github.com/gichukipaul/Citadel
- Size: 43.9 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# C I T A D E L
# Markdown to HTML Converter Mac App
This Mac app is built using:
- **Swift**: The primary programming language for developing for Apple platform.
- **MarkdownKit**: A Swift framework for rendering Markdown content.
- **HTMLKit**: A Swift framework for working with HTML content.
- **Cocoa && SwiftUI**: The native macOS and iOS frameworks for building user interfaces.
## Features
- **Markdown to HTML Conversion**: Easily convert Markdown documents to HTML with a user-friendly interface.
- **Live Preview**: Instantly preview the HTML output as you make changes to the Markdown content.
- **Syntax Highlighting**: Enhance readability with syntax highlighting for Markdown elements in the editor.
- **Responsive Design**: The app is designed to work seamlessly across different screen sizes.
## How To Get Started
To get started with the Markdown to HTML Converter Mac App, follow these steps:
1. **Download the App**: Visit our [website](https://github.com/gichukipaul/Citadel/tree/main) to download/clone the latest version of the app.
2. **Installation**: Open the downloaded DMG file and drag the app to your Applications folder.
3. **Launch the App**: Open the app from your Applications folder or the Launchpad.
4. **Convert Markdown to HTML**: Paste or write your Markdown content in the editor and click the "Convert" button to generate the HTML.
## Contributing
We welcome contributions from the community! If you'd like to contribute to the development of this app, follow these steps:
1. Fork the repository on [GitHub]([email protected]:gichukipaul/Citadel.git).
2. Clone your forked repository to your local machine.
3. Create a new branch for your feature or bug fix.
4. Make your changes and commit them with clear messages. Push your changes to your GitHub repository.
5. Submit a pull request to the main repository.
## Acknowledgments
We would like to express our gratitude to the following individuals and projects:
- **MarkdownKit and HTMLKit Contributors**: The developers of these fantastic Swift frameworks.
## License
This Markdown to HTML Converter Mac App is licensed under the [MIT License](LICENSE). Feel free to use, modify, and distribute it according to the terms of the license.
Happy converting!