AutoDoc Manual

Comprehensive Guide to Setting Up and Using AutoDoc

Line 1

Line 2

Hello World!, this is our first addon. The current server time is: 2025-11-30 22:42:20.

javascript
function greet(name) {
    console.log(`Hello, ${name}!`);
}
greet('World');
def greet(name):
    print(f"Hello, {name}!")

greet("World")
html
<!DOCTYPE html>
<html lang="en">
<head>
    <title>Hello World</title>
</head>
<body>
    <h1>Hello, World!</h1>
</body>
</html>
css
body {
    font-family: Arial, sans-serif;
    background-color: #f5f5f5;
    color: #333;
}
php
<?php
function greet($name) {
    echo "Hello, $name!";
}

greet("World");
?>

Golden Gate Bridge

Forest Gump

Content of Accordion

  • Admin panel for managing templates and configurations.
  • PDF export for downloadable documents.
  • Version control for templates and configurations.
    <?php
    echo "This is sample code block markdown";
    >

Line 1

Line 2

php
<?php
$template_file = $template_dir . $template . '.php';
ob_start();
require $template_file;
$template_content = ob_get_clean();

// Inject Highlight.js globally
$template_content = str_replace('</head>', <<<HTML
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
</head>
HTML, $template_content);

// Render the modified content
echo $template_content;
?>

Overview

AutoDoc is a dynamic web service designed to generate customizable business and legal documents using templates and configuration files. It supports seamless integration with external websites for document rendering.


Key Features


How It Works

  1. Request a document through a clean URL (e.g., /doc/privacy_policy).
  2. Use config.txt to configure variables and document links.
  3. Render the requested document using a Markdown template and the AutoDoc web service.
  4. Customize layouts and navigation for tailored user experiences.

Example Implementation

An example implementation of AutoDoc can be found at:

The setup uses the following files:


Configuration

config.txt Structure

# General Information
effective_date=March 1st, 2024
company_name=Example Company Ltd.
company_website=https://example.com
contact_email=support@example.com
company_address=1234 Example St., City, Country

# Navigation
enable_navigation=true
navigation_position=top
enable_side_menu=true

# Documents
[Documents]
privacy_policy=privacypolicy-application.md
terms_of_service=tos-application.md
refund_policy=refund-policy.md

Deployment Steps

  1. Create a /doc/ folder on the target domain.
  2. Upload index.php, config.txt, and .htaccess.
  3. Customize config.txt to reflect business details and document mappings.
  4. Test the setup by visiting URLs such as /doc/privacy_policy.

Technical Details


Future Enhancements


© 2024 Logic Everything. Powered by AutoDoc.


Reset to Default Theme

Home