Skip to content

Commit 3262f66

Browse files
github-actions[bot]github-actions[bot]
committed
chore: sync markdown files from source repo
1 parent f2c152f commit 3262f66

70 files changed

Lines changed: 3033 additions & 9 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎content/sites/groupdocs/markdown/english/net/_index.md‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,14 @@ weight: 10
55
url: /net/
66
description: GroupDocs.Markdown for .NET API References contain examples, code snippets, and API documentation. It provides namespaces, classes, interfaces, and other API details.
77
is_root: true
8-
version: "25.9"
9-
date: "2025-08-26"
10-
lastmod: "2025-08-26"
11-
categories: ["Document APIs"]
12-
tags: ["groupdocs", "markdown", "export", ".net"]
8+
version:
139
---
1410

15-
🚧 Coming Soon!
11+
## Namespaces
1612

17-
We’re preparing the first release of GroupDocs.Markdown for .NET.
18-
Very soon you’ll be able to download the library and start exporting documents to Markdown and to make your documents gen AI ready.
13+
| Namespace | Description |
14+
| --- | --- |
15+
| [GroupDocs.Markdown](./groupdocs.markdown) | The namespace contains some specific exceptions that are thrown by the library during file reading and updating. |
16+
| [GroupDocs.Markdown.Options](./groupdocs.markdown.options) | |
1917

20-
Stay tuned for updates, and check back shortly to get access to the first version! ✨
18+
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Markdown.dll -->

‎content/sites/groupdocs/markdown/english/net/groupdocs.markdown.options/_index.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: GroupDocs.Markdown.Options
3+
second_title: GroupDocs.Markdown for .NET API Reference
4+
description:
5+
type: docs
6+
weight: 20
7+
url: /net/groupdocs.markdown.options/
8+
---
9+
10+
11+
## Classes
12+
13+
| Class | Description |
14+
| --- | --- |
15+
| [LoadOptions](./loadoptions) | Allows a developer to specify additional options (such as a password) when loading a file. |
16+
17+
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Markdown.dll -->

‎content/sites/groupdocs/markdown/english/net/groupdocs.markdown.options/loadoptions/_index.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
title: LoadOptions
3+
second_title: GroupDocs.Markdown for .NET API Reference
4+
description: Allows a developer to specify additional options such as a password when loading a file.
5+
type: docs
6+
weight: 170
7+
url: /net/groupdocs.markdown.options/loadoptions/
8+
---
9+
## LoadOptions class
10+
11+
Allows a developer to specify additional options (such as a password) when loading a file.
12+
13+
```csharp
14+
public class LoadOptions
15+
```
16+
17+
## Constructors
18+
19+
| Name | Description |
20+
| --- | --- |
21+
| [LoadOptions](loadoptions#constructor)() | Initializes a new instance of the [`LoadOptions`](../loadoptions) class. |
22+
| [LoadOptions](loadoptions#constructor_1)(FileFormat) | Initializes a new instance of the [`LoadOptions`](../loadoptions) class. |
23+
24+
## Properties
25+
26+
| Name | Description |
27+
| --- | --- |
28+
| [Extension](../../groupdocs.markdown.options/loadoptions/extension) { get; set; } | Gets or sets the file extension of the stream. |
29+
| [FileFormat](../../groupdocs.markdown.options/loadoptions/fileformat) { get; } | Gets the exact type of the file that is to be loaded. The default value is Unknown which means that the type should be detected automatically. |
30+
| [MimeType](../../groupdocs.markdown.options/loadoptions/mimetype) { get; set; } | Gets or sets the MIME type of the stream. |
31+
| [Password](../../groupdocs.markdown.options/loadoptions/password) { get; set; } | Gets or sets the password for opening an encrypted document. |
32+
33+
### Remarks
34+
35+
**Learn more**
36+
37+
* [Load from a local disk](https://docs.groupdocs.com/display/markdownnet/Load+from+a+local+disk)
38+
* [Load from a stream](https://docs.groupdocs.com/display/markdownnet/Load+from+a+stream)
39+
* [Load a file of a specific format](https://docs.groupdocs.com/display/markdownnet/Load+a+file+of+a+specific+format)
40+
* [Load a password-protected document](https://docs.groupdocs.com/display/markdownnet/Load+a+password-protected+document)
41+
42+
### Examples
43+
44+
The following example shows how to create a StreamInfo instance with file extension:
45+
46+
```csharp
47+
var streamInfo = new StreamInfo
48+
{
49+
Extension = ".docx"
50+
};
51+
```
52+
53+
The following example shows how to create a StreamInfo instance with MIME type:
54+
55+
```csharp
56+
var streamInfo = new StreamInfo
57+
{
58+
MimeType = "application/msword"
59+
};
60+
```
61+
62+
### See Also
63+
64+
* namespace [GroupDocs.Markdown.Options](../../groupdocs.markdown.options)
65+
* assembly [GroupDocs.Markdown](../../)
66+
67+
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Markdown.dll -->

‎content/sites/groupdocs/markdown/english/net/groupdocs.markdown.options/loadoptions/extension/_index.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: Extension
3+
second_title: GroupDocs.Markdown for .NET API Reference
4+
description: Gets or sets the file extension of the stream.
5+
type: docs
6+
weight: 20
7+
url: /net/groupdocs.markdown.options/loadoptions/extension/
8+
---
9+
## LoadOptions.Extension property
10+
11+
Gets or sets the file extension of the stream.
12+
13+
```csharp
14+
public string Extension { get; set; }
15+
```
16+
17+
### Remarks
18+
19+
The file extension is the primary way to identify the document format. Common extensions include: - ".docx" for Word documents - ".xlsx" for Excel spreadsheets - ".pdf" for PDF files
20+
21+
### Examples
22+
23+
The following example shows how to set a file extension:
24+
25+
```csharp
26+
var streamInfo = new StreamInfo
27+
{
28+
Extension = ".docx"
29+
};
30+
```
31+
32+
### See Also
33+
34+
* class [LoadOptions](../../loadoptions)
35+
* namespace [GroupDocs.Markdown.Options](../../../groupdocs.markdown.options)
36+
* assembly [GroupDocs.Markdown](../../../)
37+
38+
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Markdown.dll -->

‎content/sites/groupdocs/markdown/english/net/groupdocs.markdown.options/loadoptions/fileformat/_index.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: FileFormat
3+
second_title: GroupDocs.Markdown for .NET API Reference
4+
description: Gets the exact type of the file that is to be loaded. The default value is Unknown which means that the type should be detected automatically.
5+
type: docs
6+
weight: 30
7+
url: /net/groupdocs.markdown.options/loadoptions/fileformat/
8+
---
9+
## LoadOptions.FileFormat property
10+
11+
Gets the exact type of the file that is to be loaded. The default value is Unknown which means that the type should be detected automatically.
12+
13+
```csharp
14+
public FileFormat FileFormat { get; }
15+
```
16+
17+
### Property Value
18+
19+
The exact type of the file that is to be loaded.
20+
21+
### See Also
22+
23+
* enum [FileFormat](../../../groupdocs.markdown/fileformat)
24+
* class [LoadOptions](../../loadoptions)
25+
* namespace [GroupDocs.Markdown.Options](../../../groupdocs.markdown.options)
26+
* assembly [GroupDocs.Markdown](../../../)
27+
28+
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Markdown.dll -->

‎content/sites/groupdocs/markdown/english/net/groupdocs.markdown.options/loadoptions/loadoptions/_index.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: LoadOptions
3+
second_title: GroupDocs.Markdown for .NET API Reference
4+
description: Initializes a new instance of the LoadOptionsgroupdocs.markdown.options/loadoptions class.
5+
type: docs
6+
weight: 10
7+
url: /net/groupdocs.markdown.options/loadoptions/loadoptions/
8+
---
9+
## LoadOptions() {#constructor}
10+
11+
Initializes a new instance of the [`LoadOptions`](../../loadoptions) class.
12+
13+
```csharp
14+
public LoadOptions()
15+
```
16+
17+
### See Also
18+
19+
* class [LoadOptions](../../loadoptions)
20+
* namespace [GroupDocs.Markdown.Options](../../../groupdocs.markdown.options)
21+
* assembly [GroupDocs.Markdown](../../../)
22+
23+
---
24+
25+
## LoadOptions(FileFormat) {#constructor_1}
26+
27+
Initializes a new instance of the [`LoadOptions`](../../loadoptions) class.
28+
29+
```csharp
30+
public LoadOptions(FileFormat fileFormat)
31+
```
32+
33+
| Parameter | Type | Description |
34+
| --- | --- | --- |
35+
| fileFormat | FileFormat | The exact type of the file. |
36+
37+
### See Also
38+
39+
* enum [FileFormat](../../../groupdocs.markdown/fileformat)
40+
* class [LoadOptions](../../loadoptions)
41+
* namespace [GroupDocs.Markdown.Options](../../../groupdocs.markdown.options)
42+
* assembly [GroupDocs.Markdown](../../../)
43+
44+
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Markdown.dll -->

‎content/sites/groupdocs/markdown/english/net/groupdocs.markdown.options/loadoptions/mimetype/_index.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: MimeType
3+
second_title: GroupDocs.Markdown for .NET API Reference
4+
description: Gets or sets the MIME type of the stream.
5+
type: docs
6+
weight: 40
7+
url: /net/groupdocs.markdown.options/loadoptions/mimetype/
8+
---
9+
## LoadOptions.MimeType property
10+
11+
Gets or sets the MIME type of the stream.
12+
13+
```csharp
14+
public string MimeType { get; set; }
15+
```
16+
17+
### Remarks
18+
19+
The MIME type helps identify the format of the document when the file extension is not available. Common MIME types include: - "application/msword" for DOC files - "application/vnd.openxmlformats-officedocument.wordprocessingml.document" for DOCX files - "application/vnd.ms-excel" for XLS files
20+
21+
### Examples
22+
23+
The following example shows how to set a MIME type:
24+
25+
```csharp
26+
var streamInfo = new StreamInfo
27+
{
28+
MimeType = "application/msword"
29+
};
30+
```
31+
32+
### See Also
33+
34+
* class [LoadOptions](../../loadoptions)
35+
* namespace [GroupDocs.Markdown.Options](../../../groupdocs.markdown.options)
36+
* assembly [GroupDocs.Markdown](../../../)
37+
38+
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Markdown.dll -->

‎content/sites/groupdocs/markdown/english/net/groupdocs.markdown.options/loadoptions/password/_index.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: Password
3+
second_title: GroupDocs.Markdown for .NET API Reference
4+
description: Gets or sets the password for opening an encrypted document.
5+
type: docs
6+
weight: 50
7+
url: /net/groupdocs.markdown.options/loadoptions/password/
8+
---
9+
## LoadOptions.Password property
10+
11+
Gets or sets the password for opening an encrypted document.
12+
13+
```csharp
14+
public string Password { get; set; }
15+
```
16+
17+
### Property Value
18+
19+
Can be null or empty string. The default value is null. If the document is not encrypted, set this to null or the empty string.
20+
21+
### See Also
22+
23+
* class [LoadOptions](../../loadoptions)
24+
* namespace [GroupDocs.Markdown.Options](../../../groupdocs.markdown.options)
25+
* assembly [GroupDocs.Markdown](../../../)
26+
27+
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Markdown.dll -->

‎content/sites/groupdocs/markdown/english/net/groupdocs.markdown/_index.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: GroupDocs.Markdown
3+
second_title: GroupDocs.Markdown for .NET API Reference
4+
description: The namespace contains some specific exceptions that are thrown by the library during file reading and updating.
5+
type: docs
6+
weight: 10
7+
url: /net/groupdocs.markdown/
8+
---
9+
The namespace contains some specific exceptions that are thrown by the library during file reading and updating.
10+
11+
## Classes
12+
13+
| Class | Description |
14+
| --- | --- |
15+
| [CustomImageSavingArgs](./customimagesavingargs) | User arguments for saving item. |
16+
| [CustomImagesStrategy.CustomImageSavingHandler](./customimagesstrategy.customimagesavinghandler) | Delegate through which you can define the mechanism for saving images when creating a .md file |
17+
| [CustomImagesStrategy](./customimagesstrategy) | Implements an image export strategy that user control how images are saved when a document is saved to Markdown format. |
18+
| [DocumentConverterOptions](./documentconverteroptions) | Provides options for customizing the document conversion process to Markdown format. |
19+
| [DocumentConverterResult](./documentconverterresult) | Represents the result of a document conversion operation to Markdown format. |
20+
| [DocumentProtectedException](./documentprotectedexception) | The exception that is thrown when document is protected by password. |
21+
| [ExportImagesAsBase64Strategy](./exportimagesasbase64strategy) | Implements an image export strategy that embeds images as Base64 strings directly in the Markdown. |
22+
| [ExportImagesToFileSystemStrategy](./exportimagestofilesystemstrategy) | Implements an image export strategy that saves images to the file system during document conversion. |
23+
| [GroupDocsMarkdownException](./groupdocsmarkdownexception) | Represents a product-specific exception that is thrown during file processing. |
24+
| [ImageExportContext](./imageexportcontext) | Represents the context for image handling during document conversion to Markdown. This context is provided by the library during conversion and contains information about the image being processed. |
25+
| [InvalidFormatException](./invalidformatexception) | The exception that is thrown when a file has an invalid format. |
26+
| [License](./license) | Provides methods for applying license to the GroupDocs.Markdown library. |
27+
| [MarkdownConverter](./markdownconverter) | Converts various document formats to Markdown format. |
28+
| [Metered](./metered) | Provides methods to set a metered key. |
29+
| [SkipImagesStrategy](./skipimagesstrategy) | Implements an image export strategy that skips saving images during document conversion. |
30+
## Interfaces
31+
32+
| Interface | Description |
33+
| --- | --- |
34+
| [IImageExportStrategy](./iimageexportstrategy) | Defines the interface for handling image export during document conversion to Markdown. Implement this interface to customize how images are exported from source documents. |
35+
## Enumeration
36+
37+
| Enumeration | Description |
38+
| --- | --- |
39+
| [FileFormat](./fileformat) | Represents the recognized format of a loaded file. |
40+
41+
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Markdown.dll -->

‎content/sites/groupdocs/markdown/english/net/groupdocs.markdown/customimagesavingargs/_index.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: CustomImageSavingArgs
3+
second_title: GroupDocs.Markdown for .NET API Reference
4+
description: User arguments for saving item.
5+
type: docs
6+
weight: 10
7+
url: /net/groupdocs.markdown/customimagesavingargs/
8+
---
9+
## CustomImageSavingArgs class
10+
11+
User arguments for saving item.
12+
13+
```csharp
14+
public class CustomImageSavingArgs
15+
```
16+
17+
## Properties
18+
19+
| Name | Description |
20+
| --- | --- |
21+
| [ImageFileName](../../groupdocs.markdown/customimagesavingargs/imagefilename) { get; } | Gets the file name (without path) where the image will be saved to. |
22+
| [ImageFileNameOutput](../../groupdocs.markdown/customimagesavingargs/imagefilenameoutput) { get; } | Gets the override file name (without path) where the image will be saved to. |
23+
| [OutputDirectory](../../groupdocs.markdown/customimagesavingargs/outputdirectory) { get; } | Get the Output Directory |
24+
| [OutputStream](../../groupdocs.markdown/customimagesavingargs/outputstream) { get; } | Gets the Output Stream |
25+
| [ShapeType](../../groupdocs.markdown/customimagesavingargs/shapetype) { get; } | Gets the shape type. |
26+
27+
## Methods
28+
29+
| Name | Description |
30+
| --- | --- |
31+
| [SetOutputImageFileName](../../groupdocs.markdown/customimagesavingargs/setoutputimagefilename)(string) | Set the file name (without path) where the image will be saved to. |
32+
| [SetOutputStream](../../groupdocs.markdown/customimagesavingargs/setoutputstream)(Stream) | Set the Output Stream |
33+
34+
### See Also
35+
36+
* namespace [GroupDocs.Markdown](../../groupdocs.markdown)
37+
* assembly [GroupDocs.Markdown](../../)
38+
39+
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Markdown.dll -->

0 commit comments

Comments
 (0)