Skip to content

Commit e35df2f

Browse files
github-actions[bot]github-actions[bot]
committed
chore: sync markdown files from source repo
1 parent 50415c5 commit e35df2f

146 files changed

Lines changed: 4293 additions & 0 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/python-net/_index.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: GroupDocs.Markdown for Python via .NET
3+
second_title: GroupDocs.Markdown for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /markdown/python-net/
7+
is_root: true
8+
weight: 10
9+
version: 26.3.0
10+
---
11+
12+
13+
### Modules
14+
| Module | Description |
15+
| :- | :- |
16+
| [`groupdocs.markdown`](/markdown/python-net/groupdocs.markdown/) | |

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

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: groupdocs.markdown
3+
second_title: GroupDocs.Markdown for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /markdown/python-net/groupdocs.markdown/
7+
is_root: false
8+
weight: 10
9+
---
10+
11+
12+
### Classes
13+
| Class | Description |
14+
| :- | :- |
15+
| [`ConvertOptions`](/markdown/python-net/groupdocs.markdown/convertoptions/) | Provides options for customizing the document conversion process to Markdown format. |
16+
| [`ConvertResult`](/markdown/python-net/groupdocs.markdown/convertresult/) | Contains the output of a successful document-to-Markdown conversion. |
17+
| [`CustomImageSavingArgs`](/markdown/python-net/groupdocs.markdown/customimagesavingargs/) | Provides information and controls for saving a single image during document-to-Markdown conversion. |
18+
| [`CustomImagesStrategy`](/markdown/python-net/groupdocs.markdown/customimagesstrategy/) | Implements an image export strategy that gives you full control over how images are saved during conversion. |
19+
| [`CustomUriExportStrategy`](/markdown/python-net/groupdocs.markdown/customuriexportstrategy/) | Implements a URI export strategy that lets you customize how resource URIs are written to Markdown. |
20+
| [`DefaultUriExportStrategy`](/markdown/python-net/groupdocs.markdown/defaulturiexportstrategy/) | Provides default URI handling that keeps the URIs generated by the library unchanged. |
21+
| [`DocumentInfo`](/markdown/python-net/groupdocs.markdown/documentinfo/) | Provides read-only metadata about a loaded document, such as its format, page count, title, and encryption status. |
22+
| [`ExportImagesAsBase64Strategy`](/markdown/python-net/groupdocs.markdown/exportimagesasbase64strategy/) | Implements an image export strategy that embeds images as Base64 strings directly in the Markdown. |
23+
| [`ExportImagesToFileSystemStrategy`](/markdown/python-net/groupdocs.markdown/exportimagestofilesystemstrategy/) | Saves images to a folder on disk during conversion. |
24+
| [`ExportOptions`](/markdown/python-net/groupdocs.markdown/exportoptions/) | Options for exporting Markdown to a document format (reverse conversion). |
25+
| [`IImageExportStrategy`](/markdown/python-net/groupdocs.markdown/iimageexportstrategy/) | Defines a strategy for handling image export during document-to-Markdown conversion. |
26+
| [`IImageSavingHandler`](/markdown/python-net/groupdocs.markdown/iimagesavinghandler/) | Callback interface invoked for each image encountered during conversion when using [`CustomImagesStrategy`](/markdown/python-net/groupdocs.markdown/customimagesstrategy/). |
27+
| [`IUriExportStrategy`](/markdown/python-net/groupdocs.markdown/iuriexportstrategy/) | Defines a strategy for customizing resource URIs that are written into the Markdown output during conversion. |
28+
| [`IUriSavingHandler`](/markdown/python-net/groupdocs.markdown/iurisavinghandler/) | Callback interface invoked for each resource URI during conversion when using [`CustomUriExportStrategy`](/markdown/python-net/groupdocs.markdown/customuriexportstrategy/); implement it to rewrite resource URIs in the Markdown output. |
29+
| [`ImageExportContext`](/markdown/python-net/groupdocs.markdown/imageexportcontext/) | Contains read-only information about a single image encountered during conversion, and is passed to `IImageExportStrategy.get_image_stream(ImageExportContext)`. |
30+
| [`License`](/markdown/python-net/groupdocs.markdown/license/) | Manages GroupDocs.Markdown licensing. |
31+
| [`LoadOptions`](/markdown/python-net/groupdocs.markdown/loadoptions/) | Specifies additional options for loading a document, such as an explicit file format or a password for encrypted files. |
32+
| [`MarkdownConverter`](/markdown/python-net/groupdocs.markdown/markdownconverter/) | Converts documents from Word, Excel, PDF, and other formats to Markdown, offering static one-liner methods and an instance-based API with full control over conversion options. |
33+
| [`Metered`](/markdown/python-net/groupdocs.markdown/metered/) | Manages metered (pay-per-use) licensing. |
34+
| [`SkipImagesStrategy`](/markdown/python-net/groupdocs.markdown/skipimagesstrategy/) | Implements an image export strategy that skips saving images during document conversion. |
35+
| [`UriExportContext`](/markdown/python-net/groupdocs.markdown/uriexportcontext/) | Contains information about a resource URI being written during conversion and is passed to [`IUriExportStrategy.update_resource_uri`](/markdown/python-net/groupdocs.markdown/iuriexportstrategy/update_resource_uri/). |
36+
| [`UriSavingArgs`](/markdown/python-net/groupdocs.markdown/urisavingargs/) | Provides information and controls for customizing how a resource URI is written during document-to-Markdown conversion. |
37+
38+
### Enumerations
39+
| Enum | Description |
40+
| :- | :- |
41+
| [`FileFormat`](/markdown/python-net/groupdocs.markdown/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). |
42+
| [`MarkdownFlavor`](/markdown/python-net/groupdocs.markdown/markdownflavor/) | Specifies the target Markdown dialect for the conversion output. |
43+
44+
### Exceptions
45+
| Exception | Description |
46+
| :- | :- |
47+
| [`DocumentProtectedException`](/markdown/python-net/groupdocs.markdown/documentprotectedexception/) | The exception that is thrown when a document is password-protected and no password (or an incorrect password) was provided via [`LoadOptions.password`](/markdown/python-net/groupdocs.markdown/loadoptions/password/). |
48+
| [`GroupDocsMarkdownException`](/markdown/python-net/groupdocs.markdown/groupdocsmarkdownexception/) | Represents a product-specific exception that is thrown during file processing. |
49+
| [`InvalidFormatException`](/markdown/python-net/groupdocs.markdown/invalidformatexception/) | The exception that is thrown when a file has an invalid format. |

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

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: __init__ constructor
3+
second_title: GroupDocs.Markdown for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /markdown/python-net/groupdocs.markdown/convertoptions/__init__/
7+
is_root: false
8+
weight: 10
9+
---
10+
11+
12+
## __init__
13+
14+
Initializes a new instance of the [`ConvertOptions`](/markdown/python-net/groupdocs.markdown/convertoptions/) class.
15+
16+
By default, [`ConvertOptions.image_export_strategy`](/markdown/python-net/groupdocs.markdown/convertoptions/image_export_strategy/) is set to [`ExportImagesAsBase64Strategy`](/markdown/python-net/groupdocs.markdown/exportimagesasbase64strategy/), which embeds images as Base64 strings directly in the Markdown output.
17+
18+
```python
19+
def __init__(self):
20+
...
21+
```
22+
23+
### See Also
24+
* class [`ConvertOptions`](/markdown/python-net/groupdocs.markdown/convertoptions/)

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

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: ConvertOptions class
3+
second_title: GroupDocs.Markdown for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /markdown/python-net/groupdocs.markdown/convertoptions/
7+
is_root: false
8+
weight: 10
9+
---
10+
11+
12+
## ConvertOptions class
13+
14+
Provides options for customizing the document conversion process to Markdown format.
15+
16+
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.
17+
18+
By default, images are embedded as Base64 strings in the Markdown output.
19+
20+
The ConvertOptions type exposes the following members:
21+
22+
### Constructors
23+
| Constructor | Description |
24+
| :- | :- |
25+
| [__init__](/markdown/python-net/groupdocs.markdown/convertoptions/__init__/) | Initializes a new instance of the [`ConvertOptions`](/markdown/python-net/groupdocs.markdown/convertoptions/) class. |
26+
27+
### Properties
28+
| Property | Description |
29+
| :- | :- |
30+
| [flavor](/markdown/python-net/groupdocs.markdown/convertoptions/flavor/) | The target Markdown dialect. Default is [`MarkdownFlavor.git_hub`](/markdown/python-net/groupdocs.markdown/markdownflavor/git_hub/). |
31+
| [heading_level_offset](/markdown/python-net/groupdocs.markdown/convertoptions/heading_level_offset/) | The offset to apply to all heading levels in the Markdown output. Default is 0 (no change). |
32+
| [image_export_strategy](/markdown/python-net/groupdocs.markdown/convertoptions/image_export_strategy/) | The strategy for handling images during conversion. Default is [`ExportImagesAsBase64Strategy`](/markdown/python-net/groupdocs.markdown/exportimagesasbase64strategy/). |
33+
| [include_front_matter](/markdown/python-net/groupdocs.markdown/convertoptions/include_front_matter/) | The option indicating whether to prepend YAML front matter to the Markdown output. Default is False. |
34+
| [include_hidden_sheets](/markdown/python-net/groupdocs.markdown/convertoptions/include_hidden_sheets/) | The property indicates whether hidden worksheets are included in spreadsheet conversions. |
35+
| [max_columns](/markdown/python-net/groupdocs.markdown/convertoptions/max_columns/) | The maximum number of columns to include per table when converting spreadsheets; columns beyond this limit are truncated with an ellipsis indicator, and a value of 0 means unlimited (default). |
36+
| [max_rows](/markdown/python-net/groupdocs.markdown/convertoptions/max_rows/) | The maximum number of data rows to include per worksheet when converting spreadsheets; rows beyond this limit are truncated with an ellipsis indicator, and a value of 0 means unlimited (default). |
37+
| [page_numbers](/markdown/python-net/groupdocs.markdown/convertoptions/page_numbers/) | The page numbers to convert, as a list of 1‑based page or worksheet numbers. |
38+
| [sheet_separator](/markdown/python-net/groupdocs.markdown/convertoptions/sheet_separator/) | The separator inserted between worksheets in spreadsheet conversions. |
39+
| [uri_export_strategy](/markdown/python-net/groupdocs.markdown/convertoptions/uri_export_strategy/) | The strategy for customizing resource URIs written to Markdown output. |
40+
41+
### See Also
42+
* module [`groupdocs.markdown`](/markdown/python-net/groupdocs.markdown/)

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

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: flavor property
3+
second_title: GroupDocs.Markdown for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /markdown/python-net/groupdocs.markdown/convertoptions/flavor/
7+
is_root: false
8+
weight: 2010
9+
---
10+
11+
12+
## flavor property
13+
14+
The target Markdown dialect. Default is [`MarkdownFlavor.git_hub`](/markdown/python-net/groupdocs.markdown/markdownflavor/git_hub/).
15+
16+
### Definition:
17+
```python
18+
@property
19+
def flavor(self):
20+
...
21+
@flavor.setter
22+
def flavor(self, value):
23+
...
24+
```
25+
26+
### See Also
27+
* class [`ConvertOptions`](/markdown/python-net/groupdocs.markdown/convertoptions/)

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

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: heading_level_offset property
3+
second_title: GroupDocs.Markdown for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /markdown/python-net/groupdocs.markdown/convertoptions/heading_level_offset/
7+
is_root: false
8+
weight: 2020
9+
---
10+
11+
12+
## heading_level_offset property
13+
14+
The offset to apply to all heading levels in the Markdown output. Default is 0 (no change).
15+
16+
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 `#`.
17+
18+
### Definition:
19+
```python
20+
@property
21+
def heading_level_offset(self):
22+
...
23+
@heading_level_offset.setter
24+
def heading_level_offset(self, value):
25+
...
26+
```
27+
28+
### See Also
29+
* class [`ConvertOptions`](/markdown/python-net/groupdocs.markdown/convertoptions/)

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

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: image_export_strategy property
3+
second_title: GroupDocs.Markdown for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /markdown/python-net/groupdocs.markdown/convertoptions/image_export_strategy/
7+
is_root: false
8+
weight: 2030
9+
---
10+
11+
12+
## image_export_strategy property
13+
14+
The strategy for handling images during conversion. Default is [`ExportImagesAsBase64Strategy`](/markdown/python-net/groupdocs.markdown/exportimagesasbase64strategy/).
15+
16+
Built-in strategies:
17+
- [`ExportImagesAsBase64Strategy`](/markdown/python-net/groupdocs.markdown/exportimagesasbase64strategy/) - Embeds images as Base64 strings (default)
18+
- [`ExportImagesToFileSystemStrategy`](/markdown/python-net/groupdocs.markdown/exportimagestofilesystemstrategy/) - Saves images to a specified folder
19+
- [`SkipImagesStrategy`](/markdown/python-net/groupdocs.markdown/skipimagesstrategy/) - Skips image saving
20+
- [`CustomImagesStrategy`](/markdown/python-net/groupdocs.markdown/customimagesstrategy/) - Custom image saving handler
21+
22+
Or implement [`IImageExportStrategy`](/markdown/python-net/groupdocs.markdown/iimageexportstrategy/) for a fully custom strategy.
23+
24+
### Definition:
25+
```python
26+
@property
27+
def image_export_strategy(self):
28+
...
29+
@image_export_strategy.setter
30+
def image_export_strategy(self, value):
31+
...
32+
```
33+
34+
### See Also
35+
* class [`ConvertOptions`](/markdown/python-net/groupdocs.markdown/convertoptions/)

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

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: include_front_matter property
3+
second_title: GroupDocs.Markdown for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /markdown/python-net/groupdocs.markdown/convertoptions/include_front_matter/
7+
is_root: false
8+
weight: 2040
9+
---
10+
11+
12+
## include_front_matter property
13+
14+
The option indicating whether to prepend YAML front matter to the Markdown output. Default is False.
15+
16+
Front matter is commonly used by static site generators such as Jekyll, Hugo, and Docusaurus. Only non-empty metadata fields are included.
17+
18+
### Definition:
19+
```python
20+
@property
21+
def include_front_matter(self):
22+
...
23+
@include_front_matter.setter
24+
def include_front_matter(self, value):
25+
...
26+
```
27+
28+
### See Also
29+
* class [`ConvertOptions`](/markdown/python-net/groupdocs.markdown/convertoptions/)

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

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: include_hidden_sheets property
3+
second_title: GroupDocs.Markdown for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /markdown/python-net/groupdocs.markdown/convertoptions/include_hidden_sheets/
7+
is_root: false
8+
weight: 2050
9+
---
10+
11+
12+
## include_hidden_sheets property
13+
14+
The property indicates whether hidden worksheets are included in spreadsheet conversions.
15+
16+
Default is False.
17+
18+
### Definition:
19+
```python
20+
@property
21+
def include_hidden_sheets(self):
22+
...
23+
@include_hidden_sheets.setter
24+
def include_hidden_sheets(self, value):
25+
...
26+
```
27+
28+
### See Also
29+
* class [`ConvertOptions`](/markdown/python-net/groupdocs.markdown/convertoptions/)

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

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: max_columns property
3+
second_title: GroupDocs.Markdown for Python via .NET API References
4+
description:
5+
type: docs
6+
url: /markdown/python-net/groupdocs.markdown/convertoptions/max_columns/
7+
is_root: false
8+
weight: 2060
9+
---
10+
11+
12+
## max_columns property
13+
14+
The maximum number of columns to include per table when converting spreadsheets; columns beyond this limit are truncated with an ellipsis indicator, and a value of 0 means unlimited (default).
15+
16+
### Definition:
17+
```python
18+
@property
19+
def max_columns(self):
20+
...
21+
@max_columns.setter
22+
def max_columns(self, value):
23+
...
24+
```
25+
26+
### See Also
27+
* class [`ConvertOptions`](/markdown/python-net/groupdocs.markdown/convertoptions/)

0 commit comments

Comments
 (0)