Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/Retrokiller543/Markdig.Prism
Browse files Browse the repository at this point in the history
  • Loading branch information
@retrokiller543
retrokiller543 committed Jul 5, 2023
2 parents 4b108a1 + 197e8bd commit a4df95f
Showing 1 changed file with 29 additions and 28 deletions.
57 changes: 29 additions & 28 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This forked version includes additional features such as a download button for c
1. Add this forked version of `Markdig.Prism` to your project.

```powershell
dotnet add package YourPackageName --version 1.0.0
dotnet add package WebStoating.Markdig.PrismWithPlugins --version 1.0.0
```

2. Create Markdig pipeline
Expand All @@ -21,7 +21,7 @@ private static readonly MarkdownPipeline MarkdownPipeline = new MarkdownPipeline
.Build();
```

3. Download [Prism](https://prismjs.com/download.html) and add it to your Razor page or layout template. Make sure to include the additional JavaScript required for the new features.
3. Download [Prism](https://prismjs.com/download.html) and add it to your Razor page or layout template. Make sure to include the additional JavaScript required for the plugins.

```html
<!DOCTYPE html>
Expand All @@ -33,6 +33,7 @@ private static readonly MarkdownPipeline MarkdownPipeline = new MarkdownPipeline
<body>
...
<script src="prism.js"></script>
<!--This would be where to put the aditiional javascript if needed for the plugin you need-->
<script src="yourAdditionalScript.js"></script>
</body>
</html>
Expand Down Expand Up @@ -72,32 +73,32 @@ new PrismExtensionOptions

| Supported | Plugin Name | Usage Guide |
| ----------- | --------- | ----------- |
| - [ ] | Line Highlight | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/LineHighlightUsage.md) |
| - [x] | Line Numbers | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/LineNumbersUsage.md) |
| - [ ] | Show Invisibles | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/ShowInvisiblesUsage.md) |
| - [ ] | Autolinker | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/AutolinkerUsage.md) |
| - [ ] | WebPlatform Docs | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/WebPlatformDocsUsage.md) |
| - [ ] | Custom Class | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/CustomClassUsage.md) |
| - [ ] | File Highlight | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/FileHighlightUsage.md) |
| - [ ] | Show Language | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/ShowLanguageUsage.md) |
| - [ ] | JSONP Highlight | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/JSONPHighlightUsage.md) |
| - [ ] | Highlight Keywords | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/HighlightKeywordsUsage.md) |
| - [ ] | Remove initial line feed | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/RemoveInitialLineFeedUsage.md) |
| - [ ] | Inline color | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/InlineColorUsage.md) |
| - [ ] | Previewers | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/PreviewersUsage.md) |
| - [ ] | Autoloader | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/AutoloaderUsage.md) |
| - [ ] | Keep Markup | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/KeepMarkupUsage.md) |
| - [ ] | Command Line | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/CommandLineUsage.md) |
| - [ ] | Unescaped Markup | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/UnescapedMarkupUsage.md) |
| - [ ] | Normalize Whitespace | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/NormalizeWhitespaceUsage.md) |
| - [ ] | Data-URI Highlight | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/DataURIHighlightUsage.md) |
| - [x] | Toolbar | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/ToolbarUsage.md) |
| - [x] | Copy to Clipboard Button | [Guide](./CopyToClipboardButtonUsage.md) |
| - [x] | Download Button | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/DownloadButtonUsage.md) |
| - [ ] | Match braces | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/MatchBracesUsage.md) |
| - [ ] | Diff Highlight | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/DiffHighlightUsage.md) |
| - [ ] | Filter highlightAll | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/FilterHighlightAllUsage.md) |
| - [ ] | Treeview | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/TreeviewUsage.md) |
| ❌ | Line Highlight | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/LineHighlightUsage.md) |
| ✅ | Line Numbers | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/LineNumbersUsage.md) |
| ❌ | Show Invisibles | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/ShowInvisiblesUsage.md) |
| ❌ | Autolinker | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/AutolinkerUsage.md) |
| ❌ | WebPlatform Docs | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/WebPlatformDocsUsage.md) |
| ❌ | Custom Class | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/CustomClassUsage.md) |
| ❌ | File Highlight | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/FileHighlightUsage.md) |
| ❌ | Show Language | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/ShowLanguageUsage.md) |
| ❌ | JSONP Highlight | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/JSONPHighlightUsage.md) |
| ❌ | Highlight Keywords | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/HighlightKeywordsUsage.md) |
| ❌ | Remove initial line feed | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/RemoveInitialLineFeedUsage.md) |
| ❌ | Inline color | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/InlineColorUsage.md) |
| ❌ | Previewers | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/PreviewersUsage.md) |
| ❌ | Autoloader | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/AutoloaderUsage.md) |
| ❌ | Keep Markup | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/KeepMarkupUsage.md) |
| ❌ | Command Line | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/CommandLineUsage.md) |
| ❌ | Unescaped Markup | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/UnescapedMarkupUsage.md) |
| ❌ | Normalize Whitespace | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/NormalizeWhitespaceUsage.md) |
| ❌ | Data-URI Highlight | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/DataURIHighlightUsage.md) |
| ✅ | Toolbar | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/ToolbarUsage.md) |
| ✅ | Copy to Clipboard Button | [Guide](./CopyToClipboardButtonUsage.md) |
| ✅ | Download Button | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/DownloadButtonUsage.md) |
| ❌ | Match braces | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/MatchBracesUsage.md) |
| ❌ | Diff Highlight | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/DiffHighlightUsage.md) |
| ❌ | Filter highlightAll | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/FilterHighlightAllUsage.md) |
| ❌ | Treeview | [Guide](https://github.com/Retrokiller543/Markdig.Prism/blob/main/docs/TreeviewUsage.md) |

## Credits

Expand Down

0 comments on commit a4df95f

Please sign in to comment.