Embedding Code Files

Estimated reading: 1 minute 25 views

Code files can be added to your documentation in two ways: Link or Embed. Choose the option that best fits your documentation.


Linking a Code File

Use Link when you simply want to reference a code file from your documentation.

How to Link

  1. Open the document where you want to add the code file.
  2. Type /.
  3. Select Link File.
  4. Search the code file.
  5. Select Link.

A clickable link is added to the document. Clicking the link opens the code file in the Code Plugin.


Embedding a Code File

Use Embed when you want to display the code directly inside your documentation.

How to Embed

  1. Open the document where you want to add the code file.
  2. Type /.
  3. Select Link File.
  4. Search the code file.
  5. Select Embed.

The code file is displayed directly within the document, providing a preview of the implementation. Readers can click Edit to open the file in the Code Plugin, execute or modify the code, and save their changes. Since the embedded view references the original file, any updates are automatically reflected in the documentation.

Leave a Reply

Your email address will not be published. Required fields are marked *

Share this Doc

Embedding Code Files

Or copy link

CONTENTS