Skip to content

Commit 5a7423a

Browse files
Merge pull request #253 from syncfusion-content/Md-Support
Markdown support changes
2 parents deaaa3f + b7353a0 commit 5a7423a

17 files changed

+163
-45
lines changed
Lines changed: 106 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,133 @@
11
---
22
layout: post
33
title: FAQ Content | Extension | Syncfusion
4-
description: The Syncfusion Document Viewer extension enables you to easily view and manage your documents within VSCode using our intuitive features.
4+
description: The Document Viewer extension enables you to easily view and manage your documents within VSCode using our intuitive features.
55
platform: extension
66
control: Syncfusion Extensions
77
documentation: ug
88
---
99

1010
# FAQ
1111

12-
### Can I edit files in the Syncfusion® Document Viewer?
12+
### What does the Document Viewer Extension do for Visual Studio Code?
1313

14-
Yes, the Syncfusion® Document Viewer allows basic editing of Word, Excel, CSV, and TSV files directly within VS Code. This extension focuses on essential<sup style="font-size:70%">&reg;</sup> editing tasks to streamline your workflow. For advanced features such as applying formulas, formatting, and complex spreadsheet functions, we recommend using the [Syncfusion® Spreadsheet component](https://www.syncfusion.com/javascript-ui-controls/js-spreadsheet).
14+
The Document Viewer lets you open and view Word, Excel, PDF, Markdown, CSV, and TSV files directly in the VS Code editor.
1515

16-
### Is the Syncfusion® Document Viewer suitable for large datasets?
16+
### How do I install and set up the Document Viewer extension?
17+
18+
To install the Document Viewer extension:
19+
- Open VS Code
20+
- Go to Extensions (Ctrl+Shift+X)
21+
- Search for "Document Viewer".
22+
- Click "Install" on the official Syncfusion extension
23+
- Restart VS Code if prompted.
24+
- The extension will automatically handle supported file types (.docx, .xlsx, .pdf, .csv, .tsv, .md).
25+
26+
### How do I view Microsoft Word documents in VS Code?
27+
28+
You can view Microsoft Word documents (.docx) directly in VS Code using the Syncfusion Document Viewer extension. Simply install the extension from the VS Code marketplace, then open any .docx file in your workspace. The extension provides a built-in viewer that renders Word documents with formatting preserved, allowing you to read and perform basic editing operations without leaving your development environment.
29+
30+
### Can I view PDF files in VS Code?
31+
32+
Yes, you can view PDF files directly in Visual Studio using the Document Viewer extension:
33+
- Install the Document Viewer extension from the VS Code Marketplace.
34+
- Open a .pdf file in your workspace.
35+
- The extension will render the PDF within VS Code, allowing you to view the document with preserved formatting. You can navigate pages, zoom in/out, and search text within the PDF.
36+
37+
### How to view and edit Excel files (.xlsx) in VS Code?
38+
39+
The Document Viewer extension allows you to view and edit Excel files (.xlsx) directly in VS Code. After installing the extension, you can:
40+
- Open .xlsx files with preserved formatting and cell structure
41+
- Edit cell contents and values
42+
- View multiple worksheets within the same file
43+
- Perform basic spreadsheet operations, such as filtering and sorting
44+
- Configure read-only mode if you only need viewing capabilities
45+
46+
### How do I view Markdown files in VS Code?
47+
48+
You can view Markdown (.md) files directly in VS Code using the Document Viewer extension. Simply install the extension from the VS Code marketplace and open any .md file in your workspace. The extension provides a built-in viewer that renders markdown files with formatting, allowing you to read and perform basic editing operations without leaving your development environment.
49+
50+
### How do I view CSV and TSV files with proper column alignment in VS Code?
51+
52+
The extension provides enhanced viewing for CSV and TSV files with proper column alignment and formatting. Features include:
53+
- Column-aligned display: Automatically formats CSV/TSV data into readable columns
54+
- Sorting capabilities: Sort data by any column in ascending or descending order
55+
- Filtering options: Filter rows based on specific criteria
56+
- Large file handling: Efficiently handles large CSV/TSV files without performance issues
57+
- Customizable display: Configure column widths and viewing preferences
58+
59+
### Can I edit files in the Document Viewer?
60+
61+
Yes, the Document Viewer allows basic editing of Word, Excel, Markdown, CSV, and TSV files directly within VS Code. This extension focuses on essential<sup style="font-size:70%">&reg;</sup> editing tasks to streamline your workflow. For advanced features such as applying formulas, formatting, and complex spreadsheet functions, we recommend using the [Syncfusion® Spreadsheet component](https://www.syncfusion.com/javascript-ui-controls/js-spreadsheet).
62+
63+
### Can I edit Word files in VS Code with this extension?
64+
65+
Yes, the Document Viewer extension supports minimal editing of Microsoft Word documents. While it's primarily designed for viewing, you can perform basic text modifications and content updates. However, for advanced formatting and complex editing tasks, you may still need to use Microsoft Word for full functionality.
66+
67+
### Is the Document Viewer suitable for large datasets?
1768

1869
Yes, the extension's sorting and filtering tools are designed to help you organize and analyze large datasets efficiently.
1970

2071
### Can I customize the document viewer features?
2172

22-
Yes, you can customize the Document Viewer’s features. Options such as read-only mode, sorting, and filtering can be managed directly from the status bar or through VS Code settings. Viewing and editing are supported for all file types included, and sorting and filtering features are specifically available for spreadsheet formats like Excel, CSV, and TSV files.
73+
Yes, you can customize the Document Viewer’s features. Options such as read-only mode, sorting, and filtering can be managed directly from the status bar or through VS Code settings. Editing is supported for all file types included except PDF, and sorting and filtering features are specifically available for spreadsheet formats like Excel, CSV, and TSV files.
2374

2475
### Is there a way to ensure data integrity while reviewing files?
2576

2677
Yes, by using the Read-Only Mode, you can ensure that data remains unchanged while reviewing sensitive or critical files.
2778

28-
### Does the Syncfusion® Document Viewer support other file formats like Word or PDF?
79+
### Does the Document Viewer support other file formats like Word or PDF?
80+
81+
Yes, it supports PDF, Word, Markdown, Excel, CSV, and TSV files.
82+
83+
### What file formats are supported by the Document Viewer extension?
84+
85+
Supported formats include:
86+
- Microsoft Word: .docx, .dotx, .docm, .dot, .doc, and .rtf files
87+
- Microsoft Excel: .xlsx, .xls, .xlsm, .xltx, .xltm, .xlsb, and .xlt files
88+
- PDF: .pdf files
89+
- Markdown: .md files
90+
- Spreadsheet formats: .csv (Comma Separated Values) and . tsv (Tab Separated Values)
91+
92+
### Does the Document Viewer support Markdown files in VS Code?
93+
94+
Yes, the Document Viewer extension does support Markdown (.md) files in Visual Studio Code. In addition to Markdown, it allows viewing and light editing of Microsoft Office documents (Word, Excel), PDFs, CSV, and TSV files directly within the VS Code editor.
95+
96+
### Does viewing PDF files in Document Viewer Extension requires any external dependencies?
97+
98+
No. The extension uses Syncfusion's standalone PDF viewer component, ensuring seamless setup and consistent PDF rendering directly within the VS Code.
99+
100+
### Does the Document Viewer Extension upload or transfer my files to a remote server before rendering them in VS Code?
101+
102+
No. The extension uses Syncfusion’s pure-JavaScript Document Editor, Spreadsheet, PDF Viewer, and Markdown editor components to parse and render your files entirely on the client. Your document data never leaves your machine, and no internet connection or server-side processing is required.
103+
104+
### How does the Document Viewer compare to other VS Code document extensions?
105+
106+
The Document Viewer stands out with:
107+
- Multi-format support: Handles both Office documents, pdf, markdown and spreadsheet files in one extension
108+
- Editing capabilities: Unlike pure viewers, it allows basic editing
109+
- Professional rendering: High-quality document display with formatting preservation
110+
- Active development: Regular updates and planned feature additions
111+
- Enterprise-grade: Built by Syncfusion, known for professional development tools
112+
113+
### How do I troubleshoot common issues with the Document Viewer extension?
29114

30-
Yes, it supports PDF, Word, Excel, CSV, and TSV files. Future updates will include MD support.
115+
Common solutions include:
116+
- Restart VS Code: Resolves most loading issues
117+
- Update extension: Ensure you have the latest version installed
118+
- Check file permissions: Verify you have read/write access to the document
119+
- Clear cache: Reload the window (Ctrl+Shift+P → "Reload Window")
120+
- Compatibility: Ensure your VS Code version is compatible with the extension
31121

32-
### Does the Syncfusion® Document Viewer Extension upload or transfer my files to a remote server before rendering it in VS Code?
122+
### Are there any limitations I should know about?
33123

34-
No. The extension uses Syncfusion’s pure-JavaScript Document Editor, Spreadsheet and PDF Viewer components to parse and render your files entirely on the client. Your document data never leaves your machine, and no internet connection or server-side processing is required.
124+
Current limitations include:
125+
- Markdown Editing: Adding images currently requires a valid image URL, as support for adding file paths is not provided.
126+
- Advanced editing: Limited to basic modifications compared to native Office applications
127+
- File size: Very large documents may have performance considerations
128+
- Complex formatting: Some advanced Word/Excel features may not render perfectly
129+
- Collaboration: Real-time collaboration features are not available
35130

36-
### Does viewing PDF files in Syncfusion® Document Viewer Extension requires any external dependencies?
131+
### How can I provide feedback or ask questions about the extension?
37132

38-
No. The extension uses Syncfusion's standalone PDF viewer component, ensuring seamless setup and consistent PDF rendering directly within the VS Code.
133+
We would love to hear from you! Please contact us through our [Syncfusion® Feedback Portal](https://www.syncfusion.com/feedback/extension).
Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: post
33
title: Configuration Options | Extension | Syncfusion
4-
description: The Syncfusion Document Viewer extension allows users to configure and customize its intuitive features effortlessly.
4+
description: The Document Viewer extension allows users to configure and customize its intuitive features effortlessly.
55
platform: extension
66
control: Syncfusion Extensions
77
documentation: ug
@@ -15,35 +15,39 @@ To prevent accidental edits to your files, you can enable Read-Only Mode.
1515

1616
- **Enable/Disable via Status Bar**:
1717

18-
After opening the file, click `Syncfusion® Document Viewer` in the status bar to toggle read-only mode on or off.
18+
After opening the file, click `Document Viewer` in the status bar to toggle read-only mode on or off.
1919
- **Spreadsheet**
2020

2121
![ReadOnly](images/ReadOnly.gif)
2222

2323
- **Word**
2424

2525
![ReadOnlyWord](images/ReadOnlyWord.gif)
26+
27+
- **Markdown**
28+
29+
![ReadOnlyMarkdown](images/ReadOnlyMarkdown.gif)
2630

2731
- **Enable/Disable via Settings**:
2832

29-
Go to **Settings > Extensions > Syncfusion® Document Viewer** to toggle read-only mode.
33+
Go to **Settings > Extensions > Document Viewer** to toggle read-only mode.
3034

3135
![ReadOnlySettings](images/ReadOnly-Config.png)
3236

3337
### Sorting and Filtering in Spreadsheet
3438

3539
You can configure sorting and filtering for the first row of your worksheet.
3640

37-
> **Note:** Syncfusion® Document Viewer enables the filtering and sorting option only when the spreadsheet files are open.
41+
> **Note:** Document Viewer enables the filtering and sorting option only when the spreadsheet files are open.
3842
3943
- **Configure via Status Bar**:
4044

41-
After opening the file, click `Syncfusion® Document Viewer` in the status bar to configure sorting and filtering on the first row of the worksheet for quicker access.
45+
After opening the file, click `Document Viewer` in the status bar to configure sorting and filtering on the first row of the worksheet for quicker access.
4246

4347
![Filtering-Toolbar](images/Filtering-Toolbar.png)
4448

4549
- **Configure via Settings**:
4650

47-
Go to **Settings > Extensions > Syncfusion® Document Viewer** to enable or disable these features.
51+
Go to **Settings > Extensions > Document Viewer** to enable or disable these features.
4852

4953
![Filter-Config](images/Filter-Config.png)
Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: post
33
title: Download and Installation | DocumentViewer | Syncfusion
4-
description: How to download the Syncfusion Document Viewer extension from the Visual Studio code marketplace site and from the Extensions View tab.
4+
description: How to download the Document Viewer extension from the Visual Studio code marketplace site and from the Extensions View tab.
55
platform: extension
66
control: Syncfusion Extensions
77
documentation: ug
@@ -17,34 +17,48 @@ Before getting started, make sure your environment meets the following requireme
1717

1818
* [Visual Studio Code](https://code.visualstudio.com/download)
1919

20-
> The minimum version of the Visual Studio Code is 1.73.0 to use the Syncfusion® Document Viewer Extension.
20+
> The minimum version of the Visual Studio Code is 1.73.0 to use the Document Viewer Extension.
2121
2222

23-
## Install through the Visual Studio Code Extensions
23+
## Install through the Visual Studio Code
2424

25-
The following steps explain how to install the Syncfusion® Document Viewer extensions from Visual Studio Code Extensions.
25+
The following steps explain how to install the Document Viewer extensions from Visual Studio Code Extensions.
2626

2727
1. Open Visual Studio Code.
2828

2929
2. Go to **View > Extensions**.
3030

31-
3. Type **Syncfusion® Document Viewer** in the search box.
31+
3. Type **Document Viewer** in the search box.
3232

3333
![Extension](images/ExtensionsView.png)
3434

35-
4. Click the Install button on the **"Syncfusion® Document Viewer"** extension.
35+
4. Click the Install button on the **"Document Viewer"** extension.
3636

3737
5. After the installation completes, restart Visual Studio Code if prompted.
3838

3939

4040
## Install from the Visual Studio Code Marketplace
4141

42-
The following steps explain how to download Syncfusion® Document Viewer extension from the Visual Studio Code Marketplace and install them.
42+
The following steps explain how to download Document Viewer extension from the Visual Studio Code Marketplace and install them.
4343

44-
1. Visit the [Syncfusion® Document Viewer Extension MarketPlace page](https://marketplace.visualstudio.com/items?itemName=SyncfusionInc.Document-Viewer-VSCode-Extensions).
44+
1. Visit the [Document Viewer Extension MarketPlace page](https://marketplace.visualstudio.com/items?itemName=SyncfusionInc.Document-Viewer-VSCode-Extensions).
4545

46-
2. Click Install from Visual Studio Code Marketplace. The browser opens the popup with the information like **“Open Visual Studio Code”**. Click Open Visual Studio Code, then [Syncfusion® Document Viewer Extension](https://marketplace.visualstudio.com/items?itemName=SyncfusionInc.Document-Viewer-VSCode-Extensions) will open in Visual Studio Code.
46+
2. Click Install from Visual Studio Code Marketplace. The browser opens the popup with the information like **“Open Visual Studio Code”**. Click Open Visual Studio Code, then [Document Viewer Extension](https://marketplace.visualstudio.com/items?itemName=SyncfusionInc.Document-Viewer-VSCode-Extensions) will open in Visual Studio Code.
4747

48-
3. Click the Install button in the **"Syncfusion® Document Viewer"** extension.
48+
3. Click the Install button in the **"Document Viewer"** extension.
4949

50-
4. After the installation, restart Visual Studio Code when suggested.
50+
4. After the installation, restart Visual Studio Code when suggested.
51+
52+
## Install Document Viewer from Visual Studio code Command Palette
53+
54+
To install the Document Viewer extension in Visual Studio Code:
55+
56+
1. Open Visual Studio Code.
57+
58+
2. Press **Ctrl + P** to open the command palette.
59+
60+
3. Type and execute the following command:
61+
62+
```
63+
ext install SyncfusionInc.Document-Viewer-VSCode-Extensions
64+
```

Extension/Document-Viewer-Extension/Visual-Studio-Code/getting-started.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
22
layout: post
33
title: Getting Started | Extension | Syncfusion
4-
description: The Syncfusion Document Viewer extension enables you to easily view and manage your documents within VSCode using our intuitive features.
4+
description: The Document Viewer extension enables you to easily view and manage your documents within VSCode using our intuitive features.
55
platform: extension
66
control: Syncfusion Extensions
77
documentation: ug
88
---
99

10-
# Getting Started with Syncfusion® Document Viewer
10+
# Getting Started with Document Viewer
1111

1212
### Open and Edit Files
1313

1414
**Open a File**:
1515

16-
- Drag and drop a Word (`.docx`, `.dotx`, `.docm`, `.dot`, `.doc`, `.rtf`), Excel (`.xlsx`, `.xls`), PDF (`.pdf`), CSV (`.csv`), and TSV (`.tsv`) files into Visual Studio Code.
16+
- Drag and drop a Word (`.docx`, `.dotx`, `.docm`, `.dot`, `.doc`, `.rtf`), Excel (`.xlsx`, `.xls`, `.xlsm`, `.xltx`, `.xltm`, `.xlsb`, `.xlt`), PDF (`.pdf`), Markdown (`.md`), CSV (`.csv`) and TSV (`.tsv`) files into Visual Studio Code.
1717

1818
- Or, go to `File > Open File` and select the file from your system.
1919

@@ -25,15 +25,15 @@ documentation: ug
2525

2626
- Save your changes by selecting `File > Save` or using the shortcut `Ctrl+S` (Windows) / `Cmd+S` (Mac).
2727

28-
> **Note:** Syncfusion® Document Viewer allows basic editing of Word, Excel, CSV, and TSV files directly within VS Code.
28+
> **Note:** Document Viewer allows basic editing of Word, Excel, Markdown, CSV, and TSV files directly within VS Code.
2929
3030
---
3131

3232
### Sorting and Filtering in Spreadsheet
3333

3434
Use the filter icons in the column headers to sort and filter data. Right-click a cell or header for advanced options.
3535

36-
> **Note:** Syncfusion® Document Viewer enables the filtering and sorting option only when the spreadsheet files are open.
36+
> **Note:** Document Viewer enables the filtering and sorting option only when the spreadsheet files are open.
3737
3838
**From column header:**
3939

80.6 KB
Loading
131 KB
Loading
42 KB
Loading
76.4 KB
Loading
78.6 KB
Loading
87.6 KB
Loading

0 commit comments

Comments
 (0)