Skip to content

Commit f9b2ca5

Browse files
Merge pull request #254 from syncfusion-content/Md-Support
New image and Faq re arrange for document viewer
2 parents c879b78 + b7353a0 commit f9b2ca5

File tree

5 files changed

+59
-52
lines changed

5 files changed

+59
-52
lines changed

Extension/Document-Viewer-Extension/Visual-Studio-Code/FAQ.md

Lines changed: 40 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -23,29 +23,16 @@ To install the Document Viewer extension:
2323
- Restart VS Code if prompted.
2424
- The extension will automatically handle supported file types (.docx, .xlsx, .pdf, .csv, .tsv, .md).
2525

26-
### Can I edit files in the Document Viewer?
27-
28-
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).
29-
30-
### Is the Document Viewer suitable for large datasets?
31-
32-
Yes, the extension's sorting and filtering tools are designed to help you organize and analyze large datasets efficiently.
33-
34-
### Can I customize the document viewer features?
35-
36-
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.
37-
38-
### Is there a way to ensure data integrity while reviewing files?
39-
40-
Yes, by using the Read-Only Mode, you can ensure that data remains unchanged while reviewing sensitive or critical files.
41-
4226
### How do I view Microsoft Word documents in VS Code?
4327

4428
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.
4529

46-
### Can I edit Word files in VS Code with this extension?
30+
### Can I view PDF files in VS Code?
4731

48-
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.
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.
4936

5037
### How to view and edit Excel files (.xlsx) in VS Code?
5138

@@ -56,6 +43,10 @@ The Document Viewer extension allows you to view and edit Excel files (.xlsx) di
5643
- Perform basic spreadsheet operations, such as filtering and sorting
5744
- Configure read-only mode if you only need viewing capabilities
5845

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+
5950
### How do I view CSV and TSV files with proper column alignment in VS Code?
6051

6152
The extension provides enhanced viewing for CSV and TSV files with proper column alignment and formatting. Features include:
@@ -65,17 +56,29 @@ The extension provides enhanced viewing for CSV and TSV files with proper column
6556
- Large file handling: Efficiently handles large CSV/TSV files without performance issues
6657
- Customizable display: Configure column widths and viewing preferences
6758

68-
### Does the Document Viewer support other file formats like Word or PDF?
59+
### Can I edit files in the Document Viewer?
6960

70-
Yes, it supports PDF, Word, Markdown, Excel, CSV, and TSV files.
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).
7162

72-
### Can I view PDF files in VS Code?
63+
### Can I edit Word files in VS Code with this extension?
7364

74-
Yes, you can view PDF files directly in Visual Studio using the Document Viewer extension:
75-
- Install the Document Viewer extension from the VS Code Marketplace.
76-
- Open a .pdf file in your workspace.
77-
- 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.
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.
7866

67+
### Is the Document Viewer suitable for large datasets?
68+
69+
Yes, the extension's sorting and filtering tools are designed to help you organize and analyze large datasets efficiently.
70+
71+
### Can I customize the document viewer features?
72+
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.
74+
75+
### Is there a way to ensure data integrity while reviewing files?
76+
77+
Yes, by using the Read-Only Mode, you can ensure that data remains unchanged while reviewing sensitive or critical files.
78+
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.
7982

8083
### What file formats are supported by the Document Viewer extension?
8184

@@ -88,19 +91,15 @@ Supported formats include:
8891

8992
### Does the Document Viewer support Markdown files in VS Code?
9093

91-
Yes, as of the latest version, 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.
92-
93-
### Does the Document Viewer Extension upload or transfer my files to a remote server before rendering them in VS Code?
94-
95-
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.
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.
9695

9796
### Does viewing PDF files in Document Viewer Extension requires any external dependencies?
9897

9998
No. The extension uses Syncfusion's standalone PDF viewer component, ensuring seamless setup and consistent PDF rendering directly within the VS Code.
10099

101-
### How do I view Markdown files in VS Code?
100+
### Does the Document Viewer Extension upload or transfer my files to a remote server before rendering them in VS Code?
102101

103-
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.
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.
104103

105104
### How does the Document Viewer compare to other VS Code document extensions?
106105

@@ -111,15 +110,6 @@ The Document Viewer stands out with:
111110
- Active development: Regular updates and planned feature additions
112111
- Enterprise-grade: Built by Syncfusion, known for professional development tools
113112

114-
### Are there any limitations I should know about?
115-
116-
Current limitations include:
117-
- Markdown Editing: Adding images currently requires a valid image URL, as support for adding file paths is not provided.
118-
- Advanced editing: Limited to basic modifications compared to native Office applications
119-
- File size: Very large documents may have performance considerations
120-
- Complex formatting: Some advanced Word/Excel features may not render perfectly
121-
- Collaboration: Real-time collaboration features are not available
122-
123113
### How do I troubleshoot common issues with the Document Viewer extension?
124114

125115
Common solutions include:
@@ -129,6 +119,15 @@ Common solutions include:
129119
- Clear cache: Reload the window (Ctrl+Shift+P → "Reload Window")
130120
- Compatibility: Ensure your VS Code version is compatible with the extension
131121

122+
### Are there any limitations I should know about?
123+
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
130+
132131
### How can I provide feedback or ask questions about the extension?
133132

134133
We would love to hear from you! Please contact us through our [Syncfusion® Feedback Portal](https://www.syncfusion.com/feedback/extension).

Extension/Document-Viewer-Extension/Visual-Studio-Code/download-and-installation.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Before getting started, make sure your environment meets the following requireme
2020
> 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

2525
The following steps explain how to install the Document Viewer extensions from Visual Studio Code Extensions.
2626

@@ -47,4 +47,18 @@ The following steps explain how to download Document Viewer extension from the V
4747

4848
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+
```
131 KB
Loading

Extension/Document-Viewer-Extension/Visual-Studio-Code/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ documentation: ug
1111

1212
## Overview
1313

14-
The **Document Viewer** extension for Visual Studio Code simplifies data handling by integrating essential features directly into the coding environment. It allows users to view Word, Excel, PDF, Markdown, CSV, and TSV files and provides editing and management features for all supported formats apart from PDF directly within Visual Studio Code without any additional tools.
14+
The **Document Viewer** extension enables developers to seamlessly view Word, Excel, Pdf, Markdown, CSV, and TSV files directly within VS Code. No more switching between applications - keep your workflow uninterrupted by viewing documents in the same environment where you code.
1515

1616
## Key Features
1717

18-
- **Effortless Viewing**: Seamlessly open and view 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.
18+
- **Effortless Viewing**: Seamlessly open and view 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.
1919

2020
- **Edit**: Edit, and save Word, Excel, Markdown, CSV, and TSV files.
2121

Extension/Document-Viewer-Extension/Visual-Studio-Code/release-notes.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,7 @@ The **Document Viewer** extension for Visual Studio Code enables developers to s
1414

1515
## Document Viewer 4.0.0
1616

17-
The **Document Viewer** 4.0.0 for Visual Studio Code now empowers seamless support for viewing and editing Markdown(`.md`) files while extending its versatility through enhanced compatibility with Excel file formats, including `.xlsm`, `.xltx`, `.xltm`, `.xlsb`, `.xlt`.
18-
19-
### Features
20-
21-
- **View and Edit Files**: Open and edit Markdown and included Excel format files within Vs code environment.
22-
- **Read-Only Mode**: Enable read-only mode to secure your content and eliminate the risk of unintended edits.
23-
- **Sorting and Filtering**:Instantly organize and explore your spreadsheet data using intuitive sorting and filtering options available in column header.
17+
The **Document Viewer** 4.0.0 for Visual Studio Code now empowers seamless support for viewing and editing Markdown (`.md`) files while extending its versatility through enhanced compatibility with Excel file formats, including `.xlsm`, `.xltx`, `.xltm`, `.xlsb`, `.xlt`.
2418

2519
---
2620

0 commit comments

Comments
 (0)