https://github.com/arklumpus/mdedit
A Markdown source code editor with syntax highlighting and real-time preview.
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (16.2%) to scientific vocabulary
Repository
A Markdown source code editor with syntax highlighting and real-time preview.
Basic Info
- Host: GitHub
- Owner: arklumpus
- License: gpl-3.0
- Language: C#
- Default Branch: main
- Size: 1.17 MB
Statistics
- Stars: 14
- Watchers: 2
- Forks: 0
- Open Issues: 0
- Releases: 3
Metadata Files
Readme.md
MDEdit - A Markdown source code editor with syntax highlighting and real-time preview.
Introduction
MDEdit is a Markdown source code editor control for Avalonia applications.
This library provides a control that can be added to Avalonia windows and integrates:
A code editor with search/replace functions and syntax highlighting.
A panel showing a preview of the document.
A panel showing the save history of the file (that can persist across different sessions, if the application implements it properly).
A panel with general settings.
It uses a modified version of CSharpEditor for the source code editor panel, and VectSharp.Markdown to render the Markdown document preview.
MDEdit is a .NET Standard 2.1 library, and should be usable in .NET Core 3.0+ and .NET 5.0+ projects. It is released under a GPLv3 licence. You can find the full documentation for this library at the documentation website. A PDF reference manual is also available.
Getting started
First of all, you need to install the NuGet package in your project.
The editor control cannot be added directly to the Window in XAML code, because it requires some non-trivial initialisation; you can create a new Editor control using the static method Editor.Create and then add it to the window:
```CSharp using MDEdit;
// ... Editor editor = await Editor.Create();
Grid grid = this.FindControl<Grid>("EditorContainer");
grid.Children.Add(editor);
```
The first time an Editor control is added to your window may take some time to initialise; subsequent Editor controls will be created much faster.
The Editor.Create static method has multiple parameters, all of which are optional:
string initialText: this is simply the initial source code that is shown in the control when it is created.string guid: this parameter provides an identifier for the control. This will be used, in particular, to store the save history of the file. If the control is initialised with the sameguidacross different sessions, the save history of the file will be restored.Shortcut[] additionalShortcuts: this makes it possible to display additional application-specific shortcuts in the shortcut section of the settings panel. Note that this does not actually implement the shortcut behaviour (which needs to be implemented separately by the developer) - it is simply provided so that users can open the settings panel and see all the shortcuts that can be used with the editor in the same place.
Take a look at the MainWindow.xaml.cs file in the MDEditDemo project to see how this works in practice.
Owner
- Name: Giorgio Bianchini
- Login: arklumpus
- Kind: user
- Company: University of Bristol
- Website: https://giorgiobianchini.com
- Repositories: 8
- Profile: https://github.com/arklumpus
GitHub Events
Total
- Watch event: 1
Last Year
- Watch event: 1
Issues and Pull Requests
Last synced: 10 months ago
All Time
- Total issues: 2
- Total pull requests: 0
- Average time to close issues: 2 months
- Average time to close pull requests: N/A
- Total issue authors: 2
- Total pull request authors: 0
- Average comments per issue: 1.5
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- Pkcarreno (1)
- assopri (1)
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- nuget 2,090 total
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 4
- Total maintainers: 1
nuget.org: mdedit
MDEdit - A Markdown source code editor with syntax highlighting and real-time preview.
- Homepage: https://github.com/arklumpus/MDEdit
- License: GPL-3.0-only
-
Latest release: 1.0.3
published over 3 years ago