You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/sites/groupdocs/markdown/english/python-net/groupdocs.markdown/_index.md
+28-24Lines changed: 28 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: groupdocs.markdown
3
3
second_title: GroupDocs.Markdown for Python via .NET API References
4
4
description:
5
5
type: docs
6
-
url: /python-net/groupdocs.markdown/
6
+
url: /markdown/python-net/groupdocs.markdown/
7
7
is_root: false
8
8
weight: 10
9
9
---
@@ -12,34 +12,38 @@ weight: 10
12
12
### Classes
13
13
| Class | Description |
14
14
| :- | :- |
15
-
|[`ConvertOptions`](/python-net/groupdocs.markdown/convertoptions/)| Provides options for customizing the document conversion process to Markdown format. |
16
-
|[`ConvertResult`](/python-net/groupdocs.markdown/convertresult/)| Contains the output of a successful document-to-Markdown conversion. |
17
-
|[`CustomImageSavingArgs`](/python-net/groupdocs.markdown/customimagesavingargs/)| Provides information and controls for saving a single image during document-to-Markdown conversion. |
18
-
|[`CustomImagesStrategy`](/python-net/groupdocs.markdown/customimagesstrategy/)| Implements an image export strategy that gives you full control over how images are saved during conversion. |
19
-
|[`CustomUriExportStrategy`](/python-net/groupdocs.markdown/customuriexportstrategy/)| Implements a URI export strategy that lets you customize how resource URIs are written to Markdown. |
20
-
|[`DefaultUriExportStrategy`](/python-net/groupdocs.markdown/defaulturiexportstrategy/)| Provides default URI handling that keeps the URIs generated by the library unchanged. |
21
-
|[`DocumentInfo`](/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`](/python-net/groupdocs.markdown/exportimagesasbase64strategy/)| Implements an image export strategy that embeds images as Base64 strings directly in the Markdown. |
23
-
|[`ExportImagesToFileSystemStrategy`](/python-net/groupdocs.markdown/exportimagestofilesystemstrategy/)| Saves images to a folder on disk during conversion. |
24
-
|[`ExportOptions`](/python-net/groupdocs.markdown/exportoptions/)| Options for exporting Markdown to a document format (reverse conversion). |
25
-
|[`ImageExportContext`](/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)`. |
|[`LoadOptions`](/python-net/groupdocs.markdown/loadoptions/)| Specifies additional options for loading a document, such as an explicit file format or a password for encrypted files. |
28
-
|[`MarkdownConverter`](/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. |
|[`SkipImagesStrategy`](/python-net/groupdocs.markdown/skipimagesstrategy/)| Implements an image export strategy that skips saving images during document conversion. |
31
-
|[`UriExportContext`](/python-net/groupdocs.markdown/uriexportcontext/)| Contains information about a resource URI being written during conversion. Passed to `IUriExportStrategy.update_resource_uri`. |
32
-
|[`UriSavingArgs`](/python-net/groupdocs.markdown/urisavingargs/)| Provides information and controls for customizing how a resource URI is written during document-to-Markdown conversion. |
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)`. |
|[`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. |
|[`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. |
33
37
34
38
### Enumerations
35
39
| Enum | Description |
36
40
| :- | :- |
37
-
|[`FileFormat`](/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). |
38
-
|[`MarkdownFlavor`](/python-net/groupdocs.markdown/markdownflavor/)| Specifies the target Markdown dialect for the conversion output. |
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. |
39
43
40
44
### Exceptions
41
45
| Exception | Description |
42
46
| :- | :- |
43
-
|[`DocumentProtectedException`](/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`](/python-net/groupdocs.markdown/loadoptions/password/). |
44
-
|[`GroupDocsMarkdownException`](/python-net/groupdocs.markdown/groupdocsmarkdownexception/)| Represents a product-specific exception that is thrown during file processing. |
45
-
|[`InvalidFormatException`](/python-net/groupdocs.markdown/invalidformatexception/)| The exception that is thrown when a file has an invalid format. |
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. |
Initializes a new instance of the [`ConvertOptions`](/python-net/groupdocs.markdown/convertoptions/) class.
14
+
Initializes a new instance of the [`ConvertOptions`](/markdown/python-net/groupdocs.markdown/convertoptions/) class.
15
15
16
-
By default, [`ConvertOptions.image_export_strategy`](/python-net/groupdocs.markdown/convertoptions/image_export_strategy/) is set to [`ExportImagesAsBase64Strategy`](/python-net/groupdocs.markdown/exportimagesasbase64strategy/), which embeds images as Base64 strings directly in the Markdown output.
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
17
18
18
```python
19
19
def__init__(self):
20
20
...
21
21
```
22
22
23
23
### See Also
24
-
* class [`ConvertOptions`](/python-net/groupdocs.markdown/convertoptions/)
24
+
* class [`ConvertOptions`](/markdown/python-net/groupdocs.markdown/convertoptions/)
@@ -22,21 +22,21 @@ The ConvertOptions type exposes the following members:
22
22
### Constructors
23
23
| Constructor | Description |
24
24
| :- | :- |
25
-
|[__init__](/python-net/groupdocs.markdown/convertoptions/__init__/)| Initializes a new instance of the [`ConvertOptions`](/python-net/groupdocs.markdown/convertoptions/) class. |
25
+
|[__init__](/markdown/python-net/groupdocs.markdown/convertoptions/__init__/)| Initializes a new instance of the [`ConvertOptions`](/markdown/python-net/groupdocs.markdown/convertoptions/) class. |
26
26
27
27
### Properties
28
28
| Property | Description |
29
29
| :- | :- |
30
-
|[flavor](/python-net/groupdocs.markdown/convertoptions/flavor/)| The target Markdown dialect. |
31
-
|[heading_level_offset](/python-net/groupdocs.markdown/convertoptions/heading_level_offset/)| The offset to apply to all heading levels in the Markdown output. |
32
-
|[image_export_strategy](/python-net/groupdocs.markdown/convertoptions/image_export_strategy/)| The strategy for handling images during conversion. The default is [`ExportImagesAsBase64Strategy`](/python-net/groupdocs.markdown/exportimagesasbase64strategy/). |
33
-
|[include_front_matter](/python-net/groupdocs.markdown/convertoptions/include_front_matter/)| The value indicating whether to prepend YAML front matter to the Markdown output. Default is False. |
34
-
|[include_hidden_sheets](/python-net/groupdocs.markdown/convertoptions/include_hidden_sheets/)| The option indicating whether hidden worksheets are included in spreadsheet conversions. |
35
-
|[max_columns](/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. 0 means unlimited (default). |
36
-
|[max_rows](/python-net/groupdocs.markdown/convertoptions/max_rows/)| The maximum number of data rows to include per worksheet when converting spreadsheets. |
37
-
|[page_numbers](/python-net/groupdocs.markdown/convertoptions/page_numbers/)| The array of 1-based page or worksheet numbers to convert; set to None to convert all pages. |
38
-
|[sheet_separator](/python-net/groupdocs.markdown/convertoptions/sheet_separator/)| The separator inserted between worksheets in spreadsheet conversions. |
39
-
|[uri_export_strategy](/python-net/groupdocs.markdown/convertoptions/uri_export_strategy/)| The strategy for customizing resource URIs written to Markdown output. |
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. |
Copy file name to clipboardExpand all lines: content/sites/groupdocs/markdown/english/python-net/groupdocs.markdown/convertoptions/heading_level_offset/_index.md
The offset to apply to all heading levels in the Markdown output.
15
-
16
-
A value of 2 turns `#` into `###`, `##` into `####`, etc. Heading levels are clamped to the range 1-6. Default is 0 (no change).
14
+
The offset to apply to all heading levels in the Markdown output. Default is 0 (no change).
17
15
18
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 `#`.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments