Skip to content

Commit 924959d

Browse files
committed
Merge branch 'master' into staging
2 parents 2558ffe + ee32737 commit 924959d

15 files changed

Lines changed: 609 additions & 99 deletions

File tree

.github/workflows/publish-prod.yml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,13 @@ jobs:
3737
cp -r nodejs-java common/content/${{ env.PRODUCT }}
3838
cp -r python-net common/content/${{ env.PRODUCT }}
3939
cp _index.md common/content/${{ env.PRODUCT }}
40-
hugo --source common --minify --config config-geekdoc.toml,ignore-total-config.toml,show-feedback-config.toml
40+
hugo --source common --minify
41+
42+
43+
- name: Move MD files to ugly URLs
44+
run: |
45+
chmod +x common/move_md_to_ugly_urls.sh
46+
./common/move_md_to_ugly_urls.sh common/public
4147
4248
- name: Deploy sitemap
4349
uses: nogsantos/scp-deploy@master
@@ -51,7 +57,7 @@ jobs:
5157
- name: Deploy documentation
5258
uses: burnett01/rsync-deployments@7.0.1
5359
with:
54-
switches: -vzr --delete
60+
switches: -vzr --delete --chmod=D755,F644
5561
path: common/public/${{ env.PRODUCT }}
5662
remote_path: ${{ secrets.DOCS_SSH_DIR }}
5763
remote_host: ${{ secrets.DOCS_SSH_HOST }}

.github/workflows/publish-qa.yml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,13 @@ jobs:
4141
cp -r nodejs-java common/content/${{ env.PRODUCT }}
4242
cp -r python-net common/content/${{ env.PRODUCT }}
4343
cp _index.md common/content/${{ env.PRODUCT }}
44-
hugo --source common --minify --config config-geekdoc.toml,ignore-total-config.toml,show-feedback-config.toml --baseURL 'https://docs-qa.groupdocs.com/'
44+
hugo --source common --minify --baseURL 'https://docs-qa.groupdocs.com/'
45+
46+
47+
- name: Move MD files to ugly URLs
48+
run: |
49+
chmod +x common/move_md_to_ugly_urls.sh
50+
./common/move_md_to_ugly_urls.sh common/public
4551
4652
- name: Deploy sitemap
4753
uses: nogsantos/scp-deploy@master
@@ -55,7 +61,7 @@ jobs:
5561
- name: Deploy documentation
5662
uses: burnett01/rsync-deployments@7.0.1
5763
with:
58-
switches: -vzr --delete
64+
switches: -vzr --delete --chmod=D755,F644
5965
path: common/public/${{ env.PRODUCT }}
6066
remote_path: ${{ secrets.DOCS_QA_SSH_DIR }}
6167
remote_host: ${{ secrets.DOCS_SSH_HOST }}

build_docs.cmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@ xcopy nodejs-java common\content\%PRODUCT%\nodejs-java /s /e /Y /i
88
xcopy python-net common\content\%PRODUCT%\python-net /s /e /Y /i
99
xcopy _index.md common\content\%PRODUCT%
1010
cd common
11-
call hugo server --config config-geekdoc.toml,ignore-total-config.toml,show-feedback-config.toml
11+
call hugo server
1212

build_docs.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ mkdir -p common/content/$PRODUCT/nodejs-java && cp -r nodejs-java common/content
99
mkdir -p common/content/$PRODUCT/python-net && cp -r python-net common/content/$PRODUCT/
1010
cp -r _index.md common/content/$PRODUCT
1111
cd common
12-
hugo server --config config-geekdoc.toml,ignore-total-config.toml,show-feedback-config.toml
12+
hugo server

common

Submodule common updated 519 files

nodejs-java/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ structuredData:
1616
<dt class="flex flex-wrap align-center gdoc-props__meta">
1717
<a href='https://releases.groupdocs.com/java/repo/com/groupdocs/groupdocs-conversion/23.12/' class="release-version-link">
1818
<span class="gdoc-props__tag tip">Latest version
19-
<i class="release-version-number">23.12</i>
20-
<i class="release-version-month">(December 2023)</i>
19+
<i class="release-version-number">25.11</i>
20+
<i class="release-version-month">(November 2025)</i>
2121
</span>
2222
</a>
2323
</dt>
Binary file not shown.
Binary file not shown.
Binary file not shown.
Lines changed: 62 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,79 @@
11
---
22
id: how-to-run-examples
33
url: conversion/nodejs-java/how-to-run-examples
4-
title: How to run examples
4+
title: How to Run Examples
55
weight: 6
6-
description: "This article describes how to run Node.js file conversion API code examples."
7-
keywords: file conversion, node.js
6+
description: "Learn how to clone, configure, and run GroupDocs.Conversion for Node.js via Java example projects."
7+
keywords: How to run a conversion, basic usage, How to run examples
88
productName: GroupDocs.Conversion for Node.js via Java
99
hideChildren: False
1010
toc: True
1111
---
12-
The complete [GroupDocs.Conversion Examples](https://github.com/groupdocs-conversion/GroupDocs.Conversion-for-Node.js-via-Java) project with code examples and sample files is hosted on GitHub.
1312

13+
The complete project [GroupDocs.Conversion for Node.js via Java — Code Examples](https://github.com/groupdocs-conversion/GroupDocs.Conversion-for-Node.js-via-Java) with runnable examples and sample files is hosted on GitHub. The structure and commands below are based on this repository and its README.
1414

15-
## Run examples using NPM
15+
## Prerequisites
1616

17-
To get started make sure that [Node.js](https://nodejs.org) is installed.
17+
Before running examples, make sure your environment meets the [System Requirements]({{< ref "conversion/nodejs-java/getting-started/system-requirements" >}}) and [Installation]({{< ref "conversion/nodejs-java/getting-started/installation" >}}) guides:
1818

19-
1. Clone repository with examples `git clone https://github.com/groupdocs-conversion/GroupDocs.Conversion-for-Node.js-via-Java.git`
20-
2. Navigate to the project folder `cd ./GroupDocs.Conversion-for-Node.js-via-Java`
21-
3. Install the necessary packages with the `npm install` command.
22-
4. Navigate to the examples folder `cd ./Examples`
23-
4. Run the examples with the `node runExamples.js` command.
19+
- **Node.js**: 20 LTS or later
20+
- **Java**: JRE/JDK 8+ (17 LTS recommended)
21+
- **Java environment**: `JAVA_HOME` set and added to `PATH`
2422

25-
To check what examples are available open `Examples/runExamples.js` file using your favorite text editor. Uncomment examples that you want to run and type `node runExamples.js` to start them.
23+
Windows PowerShell:
2624

25+
```powershell
26+
$env:JAVA_HOME="C:\Program Files\Java\jdk-17"
27+
$env:Path="$env:JAVA_HOME\bin;$env:Path"
28+
```
2729

28-
## Contribute
30+
Linux/macOS:
2931

30-
If you like to add or improve an example, we encourage you to contribute to the project. All examples in this repository are open source and can be freely used in your own applications.
32+
```bash
33+
export JAVA_HOME=/usr/lib/jvm/java-17
34+
export PATH=$JAVA_HOME/bin:$PATH
35+
```
3136

32-
To contribute, you can fork the repository, edit the source code and create a pull request. We will review the changes and include them in the repository if found helpful.
37+
For more details, see the examples repository README:
38+
[GroupDocs.Conversion for Node.js via Java — Code Examples README](https://raw.githubusercontent.com/groupdocs-conversion/GroupDocs.Conversion-for-Node.js-via-Java/refs/heads/master/README.md).
39+
40+
## Run examples using npm
41+
42+
To get started, make sure that [Node.js](https://nodejs.org/) and Java are installed and configured as described above.
43+
44+
1. **Clone the repository with examples**
45+
46+
```bash
47+
git clone https://github.com/groupdocs-conversion/GroupDocs.Conversion-for-Node.js-via-Java.git
48+
cd GroupDocs.Conversion-for-Node.js-via-Java
49+
```
50+
51+
2. **Install dependencies**
52+
53+
```bash
54+
npm install
55+
```
56+
57+
This installs the bundled `groupdocs-conversion-<version>.tgz` package and other dependencies defined in `package.json`.
58+
If installation fails with native build errors, review the build tools section in [System Requirements]({{< ref "conversion/nodejs-java/getting-started/system-requirements" >}}).
59+
60+
3. **Run all examples**
61+
62+
```bash
63+
npm start
64+
```
65+
66+
Output documents are created under the `./Examples/Output/` directory
67+
68+
## Explore available examples
69+
70+
After running the project once, you may want to see what examples are available and how they are organized:
71+
72+
- Open `examples.js` and `runExamples.js` to review the list of functions being called.
73+
- Enable or disable specific examples by editing `runExamples.js` and re-running:
74+
75+
```bash
76+
npm start
77+
```
78+
79+
Refer to the examples [README](https://github.com/groupdocs-conversion/GroupDocs.Conversion-for-Node.js-via-Java) for an overview of QuickStart, BasicUsage, and AdvancedUsage folders and the scenarios they cover.

0 commit comments

Comments
 (0)