Creating or Managing Documentation

Use the File Explorer to work with Markdown documents stored on the server.

Document Management

All documents are stored on the server, making them accessible from any device with proper permissions.

Create a new document

In the File Explorer, navigate to the folder where you want the new file.
Right-click on the folder or use the New action to open the context menu.
Select New File from the context menu to open the Create New File dialog.
In the dialog, click Choose File to select an existing Markdown document from your local system.
Enter a File Name for the document (this can be different from the original file name).
Click Create to import the document to the server.

File Import

You can import existing Markdown files from your local system and update them directly in the interface.

File Explorer showing repositories and folders with the context menu open for creating new files:

Create New File dialog showing the file selection and naming interface:

Create New File dialog with a local document selected for import:

Document successfully imported and displayed in the viewer with success notification:

Rename a document

In the File Explorer, open the context menu for the document and choose Rename File.
Enter the new name and confirm. Linked references update where supported.

Rename Considerations

When renaming files, ensure that any internal links or references are updated accordingly to maintain document integrity.

Right-click on a document to access the rename option in the context menu:

Rename File dialog showing current name and new name input field:

Document successfully renamed and displayed with the new name in the file explorer:

Edit a document

Open a Markdown file and click Edit to switch to the editor mode.
Use the toolbar for headings, bold/italics, lists, tables, code blocks, and links.
Click Close Editor to exit edit mode. You will be prompted if there are unsaved changes.

Editor Features

The editor provides both standard Markdown formatting and custom tools for image management and linking.

Editor with formatting toolbar; use Close Editor to exit:

Upload images to server

Use the Upload Image in the editor toolbar to upload an image file from your local file system to the server in the folder where the selected markdown file is

Image Storage

Images are uploaded to the same folder as the Markdown file, keeping related assets organized together.

Image successfully uploaded to the server and available for use in documents:

Insert images from server

After uploading images to the server, you can insert them into your documents using the Image Selector tool.
Click the Image Selector in the editor toolbar to browse and select from uploaded images.
Images appear at the cursor position with alt text. Adjust width or captions if needed.

Image Management

Use descriptive alt text for accessibility. You can adjust image width and add captions directly in the Markdown syntax.

Create links

Use the Add Link tool from the toolbar to create hyperlinks by selecting markdown files from the server file explorer.

Internal Linking

The Add Link tool helps create internal links between documents, making it easy to build connected documentation.

The editor toolbar provides both standard formatting options and custom functionality:

Toolbar Overview

The toolbar combines standard Markdown formatting with custom tools for image management and internal linking.

Complete editor toolbar showing all available formatting and custom options:

Standard formatting icons:

Bold (B) - Bold text formatting
Italic (I) - Italic text formatting
Strikethrough (S) - Strikethrough text formatting
Title - Dropdown to select heading levels (H1-H6)
Quote - Insert blockquotes
Code - Insert inline code or code blocks
Bullet List - Create bulleted lists
Numbered List - Create numbered lists
Image - Insert images
Link - Create hyperlinks
Table - Insert tables
Full screen - Toggle full screen mode

Custom functionality icons:

Upload Image - Upload an image from your local system to the server
Add Link - Create hyperlinks by selecting Markdown files from the server explorer
Image Selector - Browse and insert images from server library
Save - Save content

Use admonitions

Add Note, Tip, or Warning blocks in your Markdown to highlight important guidance.
These render with clear styling so readers can scan key points quickly.

Using Admonitions

Admonitions help structure your content and make important information stand out. Use them consistently throughout your documentation.

Use admonitions to call out notes, tips, and warnings in content:

Save changes and avoid data loss

Watch for Unsaved changes prompts when leaving a page mid-edit.
Confirm to discard or stay and save before navigating away.

Save Frequently

Always save your work regularly to avoid losing changes. The system will warn you about unsaved changes before navigating away.

Unsaved changes prompt appears when leaving the editor with pending edits:

Organize content

Structure pages with headings. The Table of Contents is generated from your headings.