The Documentation visualizer lets you add embed documentation in your MegunoLink project file. Use the Open web page or Open local document buttons to provide access to external document files.

The documentation visualizer has a built-in designer for you to create and edit the documentation content. Content includes text and images that are displayed in the documentation. Content is saved inside your MegunoLink project file. Your documentation can include multiple pages, which the user can navigate using links, along with external links that will open in the users default browser. Special links within the documentation will open code files in the Arduino IDE.

Documentation can be created in plain text, Markdown or HTML. HTML provides the greatest flexibility to customize the appearance of your documentation while plain text requires the least background knowledge to create. Markdown is a good compromise to create formatted documentation without deep specialized knowledge.

Documentation overview

Embed documentation and notes within your MegunoLink project using the documentation visualizer.

Create a new documentation visualizer

Create a new documentation visualizer by selecting Documentation from the Visualizer menu or toolbox.

Click the designer button () to create or edit the documentation content.

Navigating the documentation

Use the visualizer toolbar and links in the content to navigate the documentation:

  • 🏠 navigate to the documentation home-page.
  • 🢦 navigate back.
  • 🢥 navigate forward.

Editing the documentation

Click the designer button () to open the documentation designer window.

Documentation assets are listed to the left of the documentation designer. These are the images and pages that are embedded in your project to make up the documentation.

Double-click an asset in the Assets list to edit it. After making changes, click Apply all button on the toolbar to update the content in the documentation visualizer.

documentation editor

Use the documentation designer to create, edit and manage documentation assets.

Adding Assets

Add new pages or images using buttons on the toolbar. Each asset has a name, which is used to link to pages or include images in the documentation (see below).

Removing assets

To remove a page or image from the project, right-click it in the asset list and select Delete. MegunoLink will prompt you to confirm that the asset should be permanently removed from the project.

Home Page

The home page is displayed when the project is opened or whenever the user clicks the home button (🏠) in the documentation visualizer. The first page added is treated as the home page. The home page is shown in blue text in the asset list.

To change the home page document, right-click on the new home-page and select Set as Home Page.

View assets

To display the asset window, select Assets from the View menu in the documentation designer.

Referencing image assets

Use the img protocol and the image name to reference image assets in your documentation. Referenced images are shown on the documentation page.

  • In Markdown: ![tool-tip text](img:image name)
  • In HTML: <img src="img:image name" alt="tool-tip text">
  • Images are not supported in plain-text documentation.

Here, image name is the name of the asset and tool-tip text is displayed when the user’s mouse hovers over the image.

Creating page links

Use the doc protocol and the page name to create links to other pages in your documentation. Links let users navigate between pages in your documentation.

  • In Markdown: ![link text](doc:page name)
  • In HTML: <a href="doc:page name">link text</a>
  • Links are not supported in plain-text documentation.

Here, page name is the name of a page asset and link text is the text displayed for the user to click on to navigate to the page.

Creating code links

Code-links provide links to Arduino source code in your documentation pages. Code-links take two parameters:

  1. A url to the source code, and
  2. a source code filename.

MegunoLink will open the source code file in the Arduino IDE if the source file is available, otherwise it will open the url in the user’s default browser.

Source code filenames are resolved relative to the directory containing the MegunoLink project file. The url and filename are separated by a ‘|‘ and formatted like this:

  • In Markdown: [link text](code:url|source file name).
  • In HTML: <a href="code:url|source filename">link text</a>
  • Code-links are not supported in plain-text documentation.

Markdown syntax

MegunoLink supports CommonMark syntax. Check out the CommonMark cheat sheet for an introduction to common syntax.

Leave a Comment

Start typing and press Enter to search