manidoc User Manual

Simply select a tag from the dropdown (combo box) at the right end of each project row. Select "(none)" to remove the tag.

Click the "🏷 Tag Manager" button on the start screen to open the Tag Manager dialog.

Click the "Group by Tag" button on the start screen to display the project list grouped by tag. Click it again to return to normal view (sorted by SortOrder).

When you run "🌐 Bulk Web Export" and at least one project has a tag assigned, the output uses a hierarchical structure.

output-folder/
├── index.html          ← Top page (tag tiles + untagged projects)
├── tag_0/
│   ├── index.html      ← Sub-page for tag "Operations Manual" (project tiles)
│   └── tagimg.png      ← Tag image (if set)
├── tag_1/
│   └── index.html      ← Sub-page for tag "Configuration Guide"
├── a/                  ← Individual project HTML (same as before)
└── b/

• Top page: Lists tags as cards. Clicking a card navigates to that tag's sub-page.
• Tag sub-page: Lists the projects belonging to that tag, with a "← Back to Top" link.
• Untagged projects: Displayed directly at the bottom of the top page under an "(Untagged)" section.
• If no tags are assigned at all, the output uses the traditional flat structure.

Select a Markdown (.md) text file to import it as a project. Use this when you want to edit and manage existing Markdown documents in Manidoc.

Select an HTML (.html) file to import it as a project. Works with saved web pages or documents written in HTML.

Enter a URL to pull a web page in directly. The contents of a publicly accessible page can be imported and edited as a Manidoc project.

Click the "Save" button to save all nodes of the current project to disk.

Click the "Reload" button to reload the latest content from disk. Use this when the file has been changed externally, or when you want to discard unsaved changes and revert to the saved state.

Enter a URL and click the "Launch Browser" button to open that page in the built-in browser. You can combine this with the capture feature to import screenshots of that page as a node image.

Click the "Toggle Theme" button in the toolbar to switch the entire app between light mode and dark mode. The setting is remembered the next time you launch the app.

Type the heading in the text field at the top.

This is the main text area. Toolbar buttons let you apply formatting such as bold, italic, strikethrough, bullet lists, numbered lists, and tables. Frequently used buttons: Click the "✨ AI Assistant" button to have the AI suggest improvements to your text. Click the "📝 Expand Editor" button to edit in a larger window.

Click the "−" and "+" buttons at the right end of the toolbar to change the text zoom level. The current level is shown as a percentage between the buttons (e.g. 100%). You can also use Ctrl + Mouse Wheel to zoom.

• Range: 50% – 300%
• The setting is stored separately for the article and comment areas
• The zoom level is restored the next time you launch the app

You can attach one image to a node.

• "Select Image": Choose an image file from your computer
• "✨ Generate Image with AI": Describe the image in text and the AI generates it automatically
• "Edit": Add cropping, borders, or text to the image
• "Clear": Remove the attached image Image files are automatically saved to the images folder inside the project folder.

Buttons above and below the image area let you resize the panels to suit your work.

A separate field for notes, cautions, or supplementary information. Shown below the article as a "Supplement" section in HTML export.

Turn on the "Include TOC" checkbox in the toolbar to auto-generate a table of contents at the top of the page when exporting to HTML. Uncheck it to export without a table of contents.

Prepare a list of product names or topics and the AI automatically writes a document for each one.

// Load a product list and have AI auto-generate a manual for each product
var products = manidoc.readFile("data/products.txt").split("\n");

for (var i = 0; i < products.length; i++) {
    var name = products[i].trim();
    if (name === "") continue;

    var md = manidoc.askAIText(name + "の操作マニュアルをMarkdownで書いてください。## で章を分けること。");
    var proj = manidoc.createProject(name + " マニュアル");
    var top = proj.addNode("はじめに");
    top.importMarkdown(md);
    proj.save();
    manidoc.log(name + " 完了");
}

Capture application screens in sequence and automatically insert them into the corresponding nodes.

// Capture an app's screens in sequence and attach them to nodes
var proj = manidoc.openProject("操作マニュアル");
var steps = ["ログイン画面", "メインメニュー", "設定画面"];

for (var i = 0; i < steps.length; i++) {
    var node = proj.findNode(steps[i]);
    if (node === null) node = proj.addNode(steps[i]);

    var path = manidoc.captureWindow("MyApp", "screenshots/" + i + ".png");
    node.setImage(path);
    manidoc.log(steps[i] + " キャプチャ完了");
    manidoc.sleep(1000);
}
proj.save();

HTML export → Git commit → FTP upload, all in one button click.

// Export HTML, commit to Git, then upload via FTP
var proj = manidoc.openProject("製品マニュアル");
var htmlPath = proj.exportHtml(true);
manidoc.log("HTML出力: " + htmlPath);

// Git commit
var git = manidoc.execute("git add . && git commit -m \"マニュアル更新\"");
manidoc.log(git.success ? "Gitコミット完了" : "Gitエラー: " + git.error);

// FTP upload
var ftp = manidoc.execute("curl -T export/index.html ftp://user:pass@example.com/public_html/", 60);
manidoc.log(ftp.success ? "FTPアップロード完了" : "FTPエラー: " + ftp.error);

Batch-export all projects in both formats at once.

// Batch-export all projects in both HTML and Markdown
var names = manidoc.getProjects();
manidoc.log("対象: " + names.length + " プロジェクト");

for (var i = 0; i < names.length; i++) {
    var proj = manidoc.openProject(names[i]);
    if (proj === null) continue;

    var html = proj.exportHtml(true);
    var md   = proj.exportMarkdown();
    manidoc.log(names[i] + " → HTML: " + html);
    manidoc.log(names[i] + " → MD:   " + md);
}
manidoc.log("一括書き出し完了");

Creates a new project.

var proj = manidoc.createProject("新しいマニュアル");

Opens an existing project by name. The name is matched by partial match. Returns null if not found.

var proj = manidoc.openProject("社内システム");
if (proj === null) {
    manidoc.log("プロジェクトが見つかりません");
}

Opens a project whose name matches a regular expression pattern. Useful when you don't know the exact name or want to filter by condition. Returns null if not found.

// Open a project whose name contains "2026"
var proj = manidoc.openProjectByRegex("2026");

// Open a project whose name starts with "製品"
var proj = manidoc.openProjectByRegex("^製品");

if (proj === null) {
    manidoc.log("該当プロジェクトが見つかりません");
}

Returns an array of all project names in the workspace.

var names = manidoc.getProjects();
for (var i = 0; i < names.length; i++) {
    manidoc.log(names[i]);
}

Permanently deletes a project. This cannot be undone.

manidoc.deleteProject("不要なプロジェクト");

Imports a project from a Markdown file. The path can be specified relative to the workspace folder.

var proj = manidoc.importFromMarkdown("docs/manual.md");

Saves changes to disk. Always call this after making edits.

proj.name = "新しい名前";
proj.save();

Adds a root node. Returns the added node.

var node = proj.addNode("第1章 基本操作");

Searches for a root node by title (exact match).

var node = proj.getNode("第1章 基本操作");

Searches all levels (including child nodes) by title.

var node = proj.findNode("ログイン方法");

Returns all root nodes as an array.

var nodes = proj.getNodes();
for (var i = 0; i < nodes.length; i++) {
    manidoc.log(nodes[i].title);
}

Removes the root node with the specified title.

proj.removeNode("不要な章");
proj.save();

Exports the project as an HTML file. Returns the path of the output index.html.

var path = proj.exportHtml(true);   // true = include table of contents
manidoc.log("出力先: " + path);

Exports the project as a Markdown file. Returns the path of the output file.

var path = proj.exportMarkdown();
manidoc.log("出力先: " + path);

node.title = "ログイン方法";
node.article = "## 手順\n1. ID を入力\n2. パスワードを入力\n3. ログインボタンを押す";
node.comment = "パスワードは8文字以上が必要です。";
proj.save();

Adds a child node.

var parent = proj.addNode("基本操作");
var child = parent.addChild("ログイン方法");
child.article = "ログインの手順です。";
proj.save();

Searches for a direct child node by title.

var child = node.getChild("ログイン方法");

Returns all child nodes as an array.

var children = node.getChildren();

Attaches an image file to the node. The file is automatically copied to the project's images folder.

node.setImage("screenshots/login.png");
proj.save();

Compresses and attaches an image to the node. Use this to reduce file size.

// Resize to a max of 1920px at quality 80 and attach
node.setOptimizedImage("screenshots/login.png", 80, 1920);
proj.save();

Removes the image attached to the node.

node.clearImage();
proj.save();

Parses Markdown text and adds it as child nodes of this node. Handy for passing AI responses directly to auto-generate a node structure.

• The leading # Heading is used as the title of this node
• Headings from ## onward become child nodes (hierarchy is preserved)
• Returns an array of the added child nodes

var node = proj.addNode("第1章 基本操作");

// Have AI write the content in Markdown, then expand it as child nodes
var md = manidoc.askAIText("「基本操作」の操作マニュアルを Markdown で書いて。## で各手順を分けること。");
node.importMarkdown(md);

proj.save();

Captures the window with the specified title and saves it as an image file. The window title is matched by partial match.

var path = manidoc.captureWindow("Google Chrome", "screenshots/chrome.png");
node.setImage(path);
proj.save();

Captures the Manidoc window itself and saves it. No window title is needed.

var path = manidoc.captureSelf("screenshots/manidoc.png");
node.setImage(path);
proj.save();

Reads a text file and returns its contents.

var text = manidoc.readFile("data/list.txt");

Writes a text file. Creates the file if it does not exist.

manidoc.writeFile("output/result.txt", "Process complete");

Checks whether a file or folder exists.

if (manidoc.fileExists("data/list.txt")) {
    manidoc.log("File found");
}

Deletes a file or folder.

manidoc.deleteFile("output/old_result.txt");

Records a message in the execution log. Displayed in the log area of the Scripts tab.

manidoc.log("Process complete");

Returns all log messages recorded so far as a single string.

var allLog = manidoc.getLog();

Saves the current log to a file.

manidoc.saveLog("logs/run_log.md");

Returns the current date and time as a string in yyyy/MM/dd HH:mm:ss format.

manidoc.log("Run time: " + manidoc.now());

Returns the absolute path of the workspace folder.

manidoc.log("Workspace: " + manidoc.getWorkspacePath());

Pauses execution for the specified number of milliseconds.

manidoc.sleep(1000);  // Wait 1 second

Returns the Script API version.

manidoc.log("API version: " + manidoc.version());

Changes the script execution timeout. Must be placed at the very first line of the script. Writing it later has no effect.

// Example 1: Extend the timeout to 5 minutes (300 seconds)
manidoc.setTimeout(300);

// Example 2: Disable the timeout (for long batch processes)
manidoc.setTimeout(0);

manidoc.log("Starting process");
// ... long process ...
manidoc.log("Done");

A floating window appears at the top-left of the screen when the browser launches. The window can be moved by dragging.

Capture image save location: {ProjectFolder}/captures/cap_yyyyMMdd_HHmmss_NNN.png

Pressing ⏹ Stop & Save generates {workspace}/scripts/rec_yyyyMMdd_HHmmss.js. Running it from the Scripts tab replays the same operations in Chromium.

Launches Microsoft Edge or Google Chrome (whichever is installed on the system) and returns a browser operation object. Cannot launch if neither Edge nor Chrome is installed.

var browser = manidoc.openBrowser("https://example.com");
// Always close the browser when done
browser.close();

Methods on the returned object: Selector examples:

browser.click("#login-btn");           // ID
browser.fill("[name='username']", "admin");  // name attribute
browser.click("text=ログイン");         // text
browser.fill("[placeholder='パスワード']", "pass"); // placeholder

Screenshot save location: Screenshots are automatically saved to the captures/ folder in the workspace.

var path = browser.screenshot();  // "captures/cap_20260306_143022_000.png"
var node = proj.addNode("Step 1");
node.setImage(path);

Displays a text input dialog. Returns the entered string when OK is clicked. Returns an empty string "" if cancelled.

var name = manidoc.inputBox("Enter the project name");
if (name === "") {
    manidoc.log("Cancelled");
} else {
    var proj = manidoc.createProject(name);
    proj.save();
}

Displays a selection dialog with a combo box. Choices are specified as a comma-separated string. Returns the selected value when OK is clicked. Returns an empty string "" if cancelled.

var category = manidoc.selectionBox("Select a category", "Operations Manual,Configuration Guide,FAQ,Release Notes");
if (category !== "") {
    manidoc.log("Selected: " + category);
}

• instructionPath is a .md file specified relative to the workspace
• Set webSearch to true to use internet search (paid plans only; ignored when using Local LLM)
• systemPrompt is optional

{
    success: true,       // Whether it succeeded
    response: "...",     // AI response text (when success=true)
    error: ""            // Error message (when success=false)
}

// ── Pattern 1: Simple call ──────────────────────────
try {
    var md = manidoc.askAI("prompts/request.md");
    var proj = manidoc.importFromMarkdown("temp/draft.md");
    manidoc.writeFile("temp/draft.md", md);
    proj.save();
    manidoc.log("Done: " + proj.name);
} catch (e) {
    manidoc.log("Error: " + e.message);
}

// ── Pattern 2: Receive error in a variable ─────────────────────
var result = manidoc.askAIResult("prompts/request.md");
if (!result.success) {
    manidoc.log("Failed: " + result.error);
} else {
    manidoc.log(result.response);
}

// ── Pattern 3: Pass text directly ─────────────────────────
var r = manidoc.askAITextResult("Write Python installation instructions in Markdown");
if (r.success) manidoc.log(r.response);

Starts a test case.

manidoc.testStart("Project Creation Test");

Records a FAIL if the condition is false.

var proj = manidoc.openProject("テスト");
manidoc.assert(proj !== null, "Project should exist");

Records a FAIL if the two values are not equal.

manidoc.assertEqual(3, proj.nodeCount, "Node count should be 3");

Records a FAIL if the file does not exist.

manidoc.assertFileExists("output/result.html", "HTML should have been exported");

Explicitly records a test result.

if (proj !== null) {
    manidoc.testPass("Project found");
} else {
    manidoc.testFail("Project not found");
}

Returns a summary of test results in { total, passed, failed, results[] } format.

var summary = manidoc.getTestSummary();
manidoc.log("Total: " + summary.total + " / Passed: " + summary.passed + " / Failed: " + summary.failed);

Executes an external command. Lets you call tools like Git and SFTP from a script. The timeout defaults to 30 seconds if omitted. Returns an object in { success, exitCode, output, error } format.

var result = manidoc.execute("git status");
if (result.success) {
    manidoc.log(result.output);
} else {
    manidoc.log("Error: " + result.error);
}

Returns a list of script file paths registered in manifest.json inside the specified folder. Defaults to the "recordings" folder if the subfolder name is omitted.

var scripts = manidoc.listScripts("recordings");
for (var i = 0; i < scripts.length; i++) {
    manidoc.log(scripts[i]);
}

Adds another script file to the execution queue. It will be executed in order after the current script finishes.

manidoc.runScript("scripts/export_all.js");

var names = manidoc.getProjects();
manidoc.log("Project count: " + names.length);
for (var i = 0; i < names.length; i++) {
    manidoc.log((i + 1) + ". " + names[i]);
}

var proj = manidoc.createProject("操作マニュアル");
proj.description = "システムの基本操作説明書";

var ch1 = proj.addNode("第1章 はじめに");
ch1.article = "このマニュアルでは基本的な使い方を説明します。";

var ch2 = proj.addNode("第2章 基本操作");
ch2.addChild("ログイン方法");
ch2.addChild("ログアウト方法");

proj.save();
manidoc.log("Project created: " + proj.name);

var proj = manidoc.openProject("操作マニュアル");
var node = proj.findNode("ログイン方法");

var imgPath = manidoc.captureSelf("screenshots/login_screen.png");
node.setImage(imgPath);
proj.save();

manidoc.log("Capture complete");

var names = manidoc.getProjects();
for (var i = 0; i < names.length; i++) {
    var proj = manidoc.openProject(names[i]);
    if (proj !== null) {
        var path = proj.exportHtml(true);
        manidoc.log(names[i] + " → " + path);
    }
}
manidoc.log("Batch export complete");

Ask the user for a name and category during execution, then create the project accordingly.

// Ask the user for a project name
var projName = manidoc.inputBox("Enter the name of the project to create");
if (projName === "") {
    manidoc.log("Cancelled");
} else {
    // Ask the user to select a category
    var category = manidoc.selectionBox(
        "Select the document type",
        "Operations Manual,Configuration Guide,FAQ,Release Notes,Proposal"
    );

    var proj = manidoc.createProject(projName);
    proj.description = category !== "" ? category : "Document";

    // Add an initial structure based on the category
    if (category === "Operations Manual") {
        proj.addNode("Introduction");
        proj.addNode("Basic Operations");
        proj.addNode("FAQ");
    } else if (category === "FAQ") {
        proj.addNode("Installation");
        proj.addNode("Usage");
        proj.addNode("Troubleshooting");
    } else {
        proj.addNode("Overview");
        proj.addNode("Details");
    }

    proj.save();
    manidoc.log("Created: " + proj.name + " (" + proj.description + ")");
}

Read data from a text file and expand it into a node structure.

// Example content of data/chapters.txt:
// Chapter 1: Introduction
// Chapter 2: Basic Operations
// Chapter 3: Advanced Topics

var text = manidoc.readFile("data/chapters.txt");
var lines = text.split("\n");

var proj = manidoc.createProject("自動生成マニュアル");

for (var i = 0; i < lines.length; i++) {
    var title = lines[i].trim();
    if (title === "") continue;
    var node = proj.addNode(title);
    node.article = "## " + title + "\n\nEnter content here.";
    manidoc.log("Added: " + title);
}

proj.save();

// Log the result to a file
manidoc.writeFile("logs/chapter_import.txt",
    manidoc.now() + " " + proj.name + " created (" + proj.nodeCount + " chapters)");
manidoc.log("Done: " + proj.nodeCount + " chapters created");

Import multiple .md files in a folder as separate projects.

var files = ["input/manual_a.md", "input/manual_b.md", "input/manual_c.md"];

for (var i = 0; i < files.length; i++) {
    var path = files[i];

    if (!manidoc.fileExists(path)) {
        manidoc.log("Skipped (file not found): " + path);
        continue;
    }

    manidoc.log("Importing: " + path);
    var proj = manidoc.importFromMarkdown(path);
    proj.save();

    var htmlPath = proj.exportHtml(true);
    manidoc.log("Done: " + proj.name + " → " + htmlPath);
}

manidoc.log("All imports complete: " + manidoc.now());

Find old projects containing "2025" and automatically replace the year.

var names = manidoc.getProjects();
var count = 0;

for (var i = 0; i < names.length; i++) {
    // Target projects whose name contains "2025"
    if (names[i].indexOf("2025") === -1) continue;

    var proj = manidoc.openProject(names[i]);
    if (proj === null) continue;

    var oldName = proj.name;
    proj.name = oldName.replace("2025", "2026");
    proj.save();

    manidoc.log("Updated: " + oldName + " → " + proj.name);
    count++;
}

manidoc.log("Update complete: " + count + " item(s)");

Log into a web system and capture the main screens in sequence, attaching them to nodes.

var proj = manidoc.openProject("Webシステム操作マニュアル");
if (proj === null) proj = manidoc.createProject("Webシステム操作マニュアル");

var browser = manidoc.openBrowser("https://example.com/login");

// Login
browser.fill("[name='username']", "admin");
browser.fill("[name='password']", "password");
browser.click("text=ログイン");
browser.waitForUrl("dashboard");

// Capture the dashboard screen
var node1 = proj.addNode("Dashboard");
var shot1 = browser.screenshot();
node1.setImage(shot1);
node1.article = "This is the top screen shown after login.";

// Navigate to settings and capture
browser.goto("https://example.com/settings");
var node2 = proj.addNode("Settings Screen");
var shot2 = browser.screenshot();
node2.setImage(shot2);
node2.article = "The screen where you change various settings.";

browser.close();
proj.save();
manidoc.log("Capture complete: " + proj.nodeCount + " screen(s)");

Compress and resize all images in a project to reduce file size.

var proj = manidoc.openProject("操作マニュアル");
var nodes = proj.getNodes();
var count = 0;

for (var i = 0; i < nodes.length; i++) {
    var node = nodes[i];
    var imgPath = node.imagePath;

    if (imgPath === "" || imgPath === null) continue;

    // Optimize at quality 80, max 1280px and overwrite
    node.setOptimizedImage(imgPath, 80, 1280);
    count++;
    manidoc.log("Optimized: " + node.title);
}

proj.save();
manidoc.log("Optimization complete: " + count + " image(s) processed");

Automatically check that required items are present in all manuals.

manidoc.log("Quality check started: " + manidoc.now());

var names = manidoc.getProjects();

for (var i = 0; i < names.length; i++) {
    var proj = manidoc.openProject(names[i]);
    if (proj === null) continue;

    manidoc.testStart(proj.name);

    // At least one root node must exist
    manidoc.assert(proj.nodeCount > 0, "Nodes must exist");

    // An "Introduction" or "Overview" node must exist
    var intro = proj.findNode("はじめに");
    var overview = proj.findNode("概要");
    manidoc.assert(intro !== null || overview !== null, "An introductory node must exist");

    // An HTML export file must exist
    var htmlExists = manidoc.fileExists("export/" + proj.name + "/index.html");
    manidoc.assert(htmlExists, "HTML must have been exported");
}

var summary = manidoc.getTestSummary();
manidoc.log("Check result: " + summary.passed + "/" + summary.total + " passed");

// Save the result to a file
manidoc.saveLog("logs/quality_check_" + manidoc.now().replace(/[/ :]/g, "") + ".txt");