Skip to content

FontoXML/dita-example-editor

Repository files navigation

dita-example-editor

This is an example editor configuration for DITA 1.3 element support in Fonto. The code in this repository is for educational purposes. Fonto does not provide any warranty with regards to feature-completeness or stability of this package. Please see the license file for more information.

Fonto's proprietary code in platform/ is not included with this repository. Please use the FontoXML development tools to download this code. See also the install instructions in this README file.

This Fonto configuration is built for a subset of DITA 1.3 that avoids ambiguity around mixed content and block-level elements in some places.

Installation

  • Install NodeJS.
  • Make sure you have a fonto.lic license file in your project directory, or a parent directory thereof. Contact team@fontoxml.com in order to obtain a license.
  • Install FDT:
    $ npm install --global @fontoxml/fontoxml-development-tools
    
  • Download Fonto's proprietary code:
    $ cd dita-example-editor
    $ npm install
    
  • Remove the line /platform/ from the .gitignore file.
  • Commit the proprietary code in platform/ and additional configuration packages that were downloaded into packages/ to your version control.

Configuring the editor

Fonto provides a development server that will run on localhost:8080 by default, and allows you to see changes in your editor without having to rebuild the application. This is the recommended approach to rapidly iterate on your editor configuration:

$ fdt editor run

Please see documentation.fontoxml.com for extensive guides, tutorials and API reference documentation.

See also:

Deploying the editor

The application can be built using the following command:

$ fdt editor build

This compiles the various configuration source files into the dist/ directory. You can deploy the Fonto editor to your environment by serving those files from your own host.

See also:

For additional help for this command, run: $ fdt editor --help