This repository is part of the Eclipse Scout project. It contains the source of the documentation items and some demo applications created with the framework. The documentation is published on GitHub pages, and you can also find the Eclipse Scout User Guide in the Eclipse Help Center.
-
docs/modulesfolder: contains the documentation source. -
docs/playbooksfolder: contains the playbooks and user interface bundles for the Antora build, see below -
codefolder: contains demo applications (code snippets in the documentation items are extracted from this code base during the build)
The documentation is built using Antora.
There are two build targets:
-
Eclipse Scout
-
Eclipse Help
By default, Windows does not enable the creation symbolic links.
Because of that, git creates a little text file for the symbolic link docs/modules/common/examples/ → code/.
Before building the documentation, replace that file with a real symbolic link, overriding the Windows default.
Create the symbolic link manually using a cmd shell run as administrator, from the root of the working directory:
del docs\modules\common\examples mklink /d docs\modules\common\examples ..\..\..\code
On Stackoverflow you’ll find a link to a blog post from 2016 explaining that an administrator can enable Developer Mode for the local machine, allowing the creation of symbolic links. At the same time, the blog post warns of potential security issues.
|
Warning
|
This is not recommended! |
The Eclipse Scout playbook builds the site for GitHub pages. It uses the Antora Lunr Extension to provide a client-side search.
eclipse-scout-ui-bundle.zip-
the special user interface bundle for the site
local-eclipse-scout-playbook.yml-
the playbook that uses the files in the working directory
To test your changes, run:
npm run build
The Eclipse Help playbook uses a different user interface bundle without header, footer, navbar, sidebar, table of contents, and so on.
eclipse-help-ui-bundle.zip-
the special user interface bundle for sparse pages
local-eclipse-help-playbook.yml-
the playbook that uses the files in the working directory
To test your changes, run:
npm run build-help
Please note that getting the files into an actual Eclipse release requires more manual steps.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent