Skip to content

Commit ec019fa

Browse files
github-actions[bot]github-actions[bot]
committed
chore: sync markdown files from source repo
1 parent 3881a32 commit ec019fa

File tree

130 files changed

+2791
-1298
lines changed

Some content is hidden

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

130 files changed

+2791
-1298
lines changed

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ version:
1212

1313
| Namespace | Description |
1414
| --- | --- |
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.DocumentConversion](./groupdocs.markdown.documentconversion) | |
15+
| [GroupDocs.Markdown](./groupdocs.markdown) | |
1716

1817
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Markdown.dll -->

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

Lines changed: 0 additions & 17 deletions
This file was deleted.

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

Lines changed: 0 additions & 22 deletions
This file was deleted.

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

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,51 @@
11
---
22
title: GroupDocs.Markdown
33
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.
4+
description:
55
type: docs
66
weight: 10
77
url: /net/groupdocs.markdown/
88
---
9-
The namespace contains some specific exceptions that are thrown by the library during file reading and updating.
9+
1010

1111
## Classes
1212

1313
| Class | Description |
1414
| --- | --- |
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-
| [CustomUriExportStrategy](./customuriexportstrategy) | Implements a URI export strategy that lets users customize how resource URIs are written to Markdown. |
15+
| [ConvertOptions](./convertoptions) | Provides options for customizing the document conversion process to Markdown format. |
16+
| [ConvertResult](./convertresult) | Contains the output of a successful document-to-Markdown conversion. |
17+
| [CustomImageSavingArgs](./customimagesavingargs) | Provides information and controls for saving a single image during document-to-Markdown conversion. An instance of this class is passed to the callback registered with [`CustomImagesStrategy`](../groupdocs.markdown/customimagesstrategy) for each image found in the source document. |
18+
| [CustomImagesStrategy](./customimagesstrategy) | Implements an image export strategy that gives you full control over how images are saved during conversion. |
19+
| [CustomUriExportStrategy](./customuriexportstrategy) | Implements a URI export strategy that lets you customize how resource URIs are written to Markdown. |
1920
| [DefaultUriExportStrategy](./defaulturiexportstrategy) | Provides default URI handling that keeps the URIs generated by the library unchanged. |
20-
| [DocumentConverterOptions](./documentconverteroptions) | Provides options for customizing the document conversion process to Markdown format. |
21-
| [DocumentConverterResult](./documentconverterresult) | Represents the result of a document conversion operation to Markdown format. |
22-
| [DocumentProtectedException](./documentprotectedexception) | The exception that is thrown when document is protected by password. |
21+
| [DocumentInfo](./documentinfo) | Provides read-only metadata about a loaded document, such as its format, page count, title, and encryption status. |
22+
| [DocumentProtectedException](./documentprotectedexception) | The exception that is thrown when a document is password-protected and no password (or an incorrect password) was provided via [`Password`](../groupdocs.markdown/loadoptions/password). |
2323
| [ExportImagesAsBase64Strategy](./exportimagesasbase64strategy) | Implements an image export strategy that embeds images as Base64 strings directly in the Markdown. |
24-
| [ExportImagesToFileSystemStrategy](./exportimagestofilesystemstrategy) | Implements an image export strategy that saves images to the file system during document conversion. |
24+
| [ExportImagesToFileSystemStrategy](./exportimagestofilesystemstrategy) | Saves images to a folder on disk during conversion. |
25+
| [ExportOptions](./exportoptions) | Options for exporting Markdown to a document format (reverse conversion). |
2526
| [GroupDocsMarkdownException](./groupdocsmarkdownexception) | Represents a product-specific exception that is thrown during file processing. |
26-
| [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. |
27+
| [ImageExportContext](./imageexportcontext) | Contains read-only information about a single image encountered during conversion. Passed to [`GetImageStream`](../groupdocs.markdown/iimageexportstrategy/getimagestream). |
2728
| [InvalidFormatException](./invalidformatexception) | The exception that is thrown when a file has an invalid format. |
28-
| [License](./license) | Provides methods for applying license to the GroupDocs.Markdown library. |
29-
| [LoadOptions](./loadoptions) | Allows a developer to specify additional options (such as a password) when loading a file. |
30-
| [MarkdownConverter](./markdownconverter) | Converts various document formats to Markdown format. |
31-
| [Metered](./metered) | Provides methods to set a metered key. |
29+
| [License](./license) | Provides methods to license the component. Learn more about licensing [here](https://purchase.groupdocs.com/faqs/licensing). |
30+
| [LoadOptions](./loadoptions) | Specifies additional options for loading a document, such as an explicit file format or a password for encrypted files. |
31+
| [MarkdownConverter](./markdownconverter) | Converts documents from Word, Excel, PDF, and other formats to Markdown. Provides both static one-liner methods and an instance-based API with full control over conversion options. |
32+
| [Metered](./metered) | Provides methods for applying [Metered](https://purchase.groupdocs.com/faqs/licensing/metered) license. |
3233
| [SkipImagesStrategy](./skipimagesstrategy) | Implements an image export strategy that skips saving images during document conversion. |
33-
| [UriExportContext](./uriexportcontext) | Represents the context for resource URI handling during document conversion to Markdown. |
34-
| [UriSavingArgs](./urisavingargs) | User arguments for saving a resource URI. |
35-
| [CustomUriExportStrategy.UriSavingHandler](./customuriexportstrategy.urisavinghandler) | Delegate through which you can define the URI generation logic when creating a .md file. |
34+
| [UriExportContext](./uriexportcontext) | Contains information about a resource URI being written during conversion. Passed to [`UpdateResourceUri`](../groupdocs.markdown/iuriexportstrategy/updateresourceuri). |
35+
| [UriSavingArgs](./urisavingargs) | Provides information and controls for customizing how a resource URI is written during document-to-Markdown conversion. An instance of this class is created for each resource and can be used to override the default URI or file name. |
3636
## Interfaces
3737

3838
| Interface | Description |
3939
| --- | --- |
40-
| [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. |
41-
| [IUriExportStrategy](./iuriexportstrategy) | Defines the interface for handling resource URI export during document conversion to Markdown. |
40+
| [IImageExportStrategy](./iimageexportstrategy) | Defines a strategy for handling image export during document-to-Markdown conversion. Implement this interface to control where and how images extracted from the source document are stored. |
41+
| [IImageSavingHandler](./iimagesavinghandler) | Callback interface invoked for each image encountered during conversion when using [`CustomImagesStrategy`](../groupdocs.markdown/customimagesstrategy). Implement this interface to rename images, redirect output to a custom stream, or apply other custom logic. |
42+
| [IUriExportStrategy](./iuriexportstrategy) | Defines a strategy for customizing resource URIs that are written into the Markdown output during conversion. |
43+
| [IUriSavingHandler](./iurisavinghandler) | Callback interface invoked for each resource URI during conversion when using [`CustomUriExportStrategy`](../groupdocs.markdown/customuriexportstrategy). Implement this interface to rewrite resource URIs in the Markdown output. |
4244
## Enumeration
4345

4446
| Enumeration | Description |
4547
| --- | --- |
46-
| [FileFormat](./fileformat) | Represents the recognized format of a loaded file. |
48+
| [FileFormat](./fileformat) | Specifies a document file format. Used both as input format (when loading a document for conversion to Markdown) and as output format (when exporting Markdown to a document). |
49+
| [MarkdownFlavor](./markdownflavor) | Specifies the target Markdown dialect for the conversion output. |
4750

4851
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Markdown.dll -->

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

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
---
2+
title: ConvertOptions
3+
second_title: GroupDocs.Markdown for .NET API Reference
4+
description: Provides options for customizing the document conversion process to Markdown format.
5+
type: docs
6+
weight: 10
7+
url: /net/groupdocs.markdown/convertoptions/
8+
---
9+
## ConvertOptions class
10+
11+
Provides options for customizing the document conversion process to Markdown format.
12+
13+
```csharp
14+
public class ConvertOptions
15+
```
16+
17+
## Constructors
18+
19+
| Name | Description |
20+
| --- | --- |
21+
| [ConvertOptions](convertoptions)() | Initializes a new instance of the [`ConvertOptions`](../convertoptions) class. |
22+
23+
## Properties
24+
25+
| Name | Description |
26+
| --- | --- |
27+
| [Flavor](../../groupdocs.markdown/convertoptions/flavor) { get; set; } | Gets or sets the target Markdown dialect. |
28+
| [HeadingLevelOffset](../../groupdocs.markdown/convertoptions/headingleveloffset) { get; set; } | Gets or sets the offset to apply to all heading levels in the Markdown output. A value of 2 turns `#` into `###`, `##` into `####`, etc. Heading levels are clamped to the range 1-6. |
29+
| [ImageExportStrategy](../../groupdocs.markdown/convertoptions/imageexportstrategy) { get; set; } | Gets or sets the strategy for handling images during conversion. |
30+
| [IncludeFrontMatter](../../groupdocs.markdown/convertoptions/includefrontmatter) { get; set; } | Gets or sets a value indicating whether to prepend YAML front matter to the Markdown output. When enabled, document metadata (title, author, format, page count) is extracted and written as a YAML block at the beginning of the output. |
31+
| [IncludeHiddenSheets](../../groupdocs.markdown/convertoptions/includehiddensheets) { get; set; } | Gets or sets whether hidden worksheets are included in spreadsheet conversions. |
32+
| [MaxColumns](../../groupdocs.markdown/convertoptions/maxcolumns) { get; set; } | Gets or sets the maximum number of columns to include per table when converting spreadsheets. Columns beyond this limit are truncated with an ellipsis indicator. |
33+
| [MaxRows](../../groupdocs.markdown/convertoptions/maxrows) { get; set; } | Gets or sets the maximum number of data rows to include per worksheet when converting spreadsheets. Rows beyond this limit are truncated with an ellipsis indicator. |
34+
| [PageNumbers](../../groupdocs.markdown/convertoptions/pagenumbers) { get; set; } | Gets or sets an array of page or worksheet numbers to convert. Numbering starts from 1. |
35+
| [SheetSeparator](../../groupdocs.markdown/convertoptions/sheetseparator) { get; set; } | Gets or sets the separator inserted between worksheets in spreadsheet conversions. |
36+
| [UriExportStrategy](../../groupdocs.markdown/convertoptions/uriexportstrategy) { get; set; } | Gets or sets the strategy for customizing resource URIs written to Markdown output. |
37+
38+
### Remarks
39+
40+
This class allows you to configure how documents are converted to Markdown, including how images are exported, how resource URIs are written, which pages to convert, and how heading levels are adjusted.
41+
42+
By default, images are embedded as Base64 strings in the Markdown output.
43+
44+
### Examples
45+
46+
The following examples show different ways to configure conversion options:
47+
48+
```csharp
49+
// Example 1: Using default options (images embedded as Base64)
50+
var options = new ConvertOptions();
51+
52+
// Example 2: Saving images to a folder
53+
var options = new ConvertOptions
54+
{
55+
ImageExportStrategy = new ExportImagesToFileSystemStrategy("output/images")
56+
};
57+
58+
// Example 3: Skipping image export
59+
var options = new ConvertOptions
60+
{
61+
ImageExportStrategy = new SkipImagesStrategy()
62+
};
63+
64+
// Example 4: Converting only the first 3 pages
65+
var options = new ConvertOptions
66+
{
67+
PageNumbers = new[] { 1, 2, 3 }
68+
};
69+
70+
// Example 5: Shifting headings down by 2 levels (# becomes ###)
71+
var options = new ConvertOptions
72+
{
73+
HeadingLevelOffset = 2
74+
};
75+
76+
// Example 6: Generating YAML front matter from document metadata
77+
var options = new ConvertOptions
78+
{
79+
IncludeFrontMatter = true
80+
};
81+
82+
// Example 7: Combining multiple options
83+
var options = new ConvertOptions
84+
{
85+
ImageExportStrategy = new ExportImagesToFileSystemStrategy("images"),
86+
HeadingLevelOffset = 1,
87+
IncludeFrontMatter = true,
88+
PageNumbers = new[] { 1, 2 }
89+
};
90+
```
91+
92+
### See Also
93+
94+
* namespace [GroupDocs.Markdown](../../groupdocs.markdown)
95+
* assembly [GroupDocs.Markdown](../../)
96+
97+
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Markdown.dll -->

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

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: ConvertOptions
3+
second_title: GroupDocs.Markdown for .NET API Reference
4+
description: Initializes a new instance of the ConvertOptionsgroupdocs.markdown/convertoptions class.
5+
type: docs
6+
weight: 10
7+
url: /net/groupdocs.markdown/convertoptions/convertoptions/
8+
---
9+
## ConvertOptions constructor
10+
11+
Initializes a new instance of the [`ConvertOptions`](../../convertoptions) class.
12+
13+
```csharp
14+
public ConvertOptions()
15+
```
16+
17+
### Remarks
18+
19+
By default, [`ImageExportStrategy`](../imageexportstrategy) is set to [`ExportImagesAsBase64Strategy`](../../exportimagesasbase64strategy), which embeds images as Base64 strings directly in the Markdown output.
20+
21+
### See Also
22+
23+
* class [ConvertOptions](../../convertoptions)
24+
* namespace [GroupDocs.Markdown](../../../groupdocs.markdown)
25+
* assembly [GroupDocs.Markdown](../../../)
26+
27+
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Markdown.dll -->

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

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: Flavor
3+
second_title: GroupDocs.Markdown for .NET API Reference
4+
description: Gets or sets the target Markdown dialect.
5+
type: docs
6+
weight: 20
7+
url: /net/groupdocs.markdown/convertoptions/flavor/
8+
---
9+
## ConvertOptions.Flavor property
10+
11+
Gets or sets the target Markdown dialect.
12+
13+
```csharp
14+
public MarkdownFlavor Flavor { get; set; }
15+
```
16+
17+
### Property Value
18+
19+
Default is GitHub.
20+
21+
### See Also
22+
23+
* enum [MarkdownFlavor](../../markdownflavor)
24+
* class [ConvertOptions](../../convertoptions)
25+
* namespace [GroupDocs.Markdown](../../../groupdocs.markdown)
26+
* assembly [GroupDocs.Markdown](../../../)
27+
28+
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Markdown.dll -->

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

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: HeadingLevelOffset
3+
second_title: GroupDocs.Markdown for .NET API Reference
4+
description: Gets or sets the offset to apply to all heading levels in the Markdown output. A value of 2 turns into into etc. Heading levels are clamped to the range 16.
5+
type: docs
6+
weight: 30
7+
url: /net/groupdocs.markdown/convertoptions/headingleveloffset/
8+
---
9+
## ConvertOptions.HeadingLevelOffset property
10+
11+
Gets or sets the offset to apply to all heading levels in the Markdown output. A value of 2 turns `#` into `###`, `##` into `####`, etc. Heading levels are clamped to the range 1-6.
12+
13+
```csharp
14+
public int HeadingLevelOffset { get; set; }
15+
```
16+
17+
### Property Value
18+
19+
Default is 0 (no change).
20+
21+
### Remarks
22+
23+
This is useful when you are embedding the converted Markdown inside a larger document where top-level headings are already in use. For example, setting this to 1 ensures the converted content starts at `##` instead of `#`.
24+
25+
### Examples
26+
27+
Shift all headings down by one level so that source `H1` becomes Markdown `##`:
28+
29+
```csharp
30+
var options = new ConvertOptions { HeadingLevelOffset = 1 };
31+
string markdown = MarkdownConverter.ToMarkdown("document.docx", options);
32+
```
33+
34+
### See Also
35+
36+
* class [ConvertOptions](../../convertoptions)
37+
* namespace [GroupDocs.Markdown](../../../groupdocs.markdown)
38+
* assembly [GroupDocs.Markdown](../../../)
39+
40+
<!-- DO NOT EDIT: generated by xmldocmd for GroupDocs.Markdown.dll -->

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

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: ImageExportStrategy
3+
second_title: GroupDocs.Markdown for .NET API Reference
4+
description: Gets or sets the strategy for handling images during conversion.
5+
type: docs
6+
weight: 40
7+
url: /net/groupdocs.markdown/convertoptions/imageexportstrategy/
8+
---
9+
## ConvertOptions.ImageExportStrategy property
10+
11+
Gets or sets the strategy for handling images during conversion.
12+
13+
```csharp
14+
public IImageExportStrategy ImageExportStrategy { get; set; }
15+
```
16+
17+
### Property Value
18+
19+
The image export strategy. Default is [`ExportImagesAsBase64Strategy`](../../exportimagesasbase64strategy).
20+
21+
### Remarks
22+
23+
Built-in strategies:
24+
25+
* [`ExportImagesAsBase64Strategy`](../../exportimagesasbase64strategy) - Embeds images as Base64 strings (default)
26+
* [`ExportImagesToFileSystemStrategy`](../../exportimagestofilesystemstrategy) - Saves images to a specified folder
27+
* [`SkipImagesStrategy`](../../skipimagesstrategy) - Skips image saving
28+
* [`CustomImagesStrategy`](../../customimagesstrategy) - Custom image saving handler
29+
30+
Or implement [`IImageExportStrategy`](../../iimageexportstrategy) for a fully custom strategy.
31+
32+
### See Also
33+
34+
* interface [IImageExportStrategy](../../iimageexportstrategy)
35+
* class [ConvertOptions](../../convertoptions)
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)