AutoManual User Guide

Welcome to the AutoManual User Guide! This document explains how to use the AutoManual system for creating, managing, and displaying Markdown-based manuals.

Overview

The AutoManual project is a lightweight solution for creating and rendering Markdown files with customizable templates. It supports:

• Markdown Files: Manuals are stored as .md files.
• Custom Templates: Render manuals using different templates (e.g., default, basic, paper).
• Simple URL Parameters: Select manuals and templates using query strings in the URL.

Features

1. Markdown Support

AutoManual supports Markdown syntax for creating rich text content, such as:

• Headers
• Lists
• Code blocks
• Links

2. Custom Templates

Choose different templates for rendering manuals by specifying the template parameter in the URL. Default templates include:

• default: A clean and minimal layout.
• basic: A simpler design with serif fonts.
• paper: A professional paper-style layout.

3. Easy Integration

The system works without a database. Manuals are stored as .md files in the /manual/ folder, and templates are stored in the /templates/ folder.

Getting Started

1. Default Manual

To view the default manual (help.md) with the default template:

https://logiceverything.com/automanual

2. Specify a Manual

To view a specific manual (e.g., autodoc.md), use the manual parameter:

https://logiceverything.com/automanual?manual=autodoc

3. Specify a Template

To use a different template (e.g., paper), use the template parameter:

https://logiceverything.com/automanual?manual=autodoc&template=paper

Markdown Syntax Examples

Here are some examples of Markdown syntax supported by AutoManual:

Headers

# H1
## H2
### H3

Lists

- Item 1
- Item 2
  - Subitem 2.1

Links

[AutoManual Homepage](https://logiceverything.com/automanual)

AutoManual Homepage

Code Block

echo "Hello, World!";

Folder Structure

AutoManual uses the following folder structure:

/automanual
├── index.php               # Lists all manuals (formerly list.php)
├── show.php                # Main file to parse and render manuals
├── .htaccess               # Rewrite rules for clean URLs
├── /templates/             # Contains template files for rendering manuals
│   ├── default.php
│   ├── paper.php
│   ├── github.php          # GitHub-inspired template with light and dark mode
├── /manual/                # Contains Markdown files
│   ├── help.md             # Default manual
│   ├── autodoc.md          # Example manual
│   ├── githubdemo.md       # Markdown demo for GitHub-inspired style

Templates

Default Template

A clean and minimal layout. Use this with the template=default parameter.

Basic Template

A simpler design with serif fonts. Use this with the template=basic parameter.

Paper Template

A professional paper-style layout. Use this with the template=paper parameter.

Adding a New Manual

To add a new manual:

1. Create a new Markdown file in the /manual/ folder.
2. Use the manual parameter in the URL to access it.

Example:

• File: /manual/example.md
• URL: https://logiceverything.com/automanual?manual=example

Adding a New Template

To add a new template:

1. Create a new PHP file in the /templates/ folder.
2. Use the template parameter in the URL to access it.

Example:

• File: /templates/custom.php
• URL: https://logiceverything.com/automanual?manual=example&template=custom

Troubleshooting

Manual Not Found

If you see a "Manual not found!" message:

• Ensure the file exists in the /manual/ folder.
• Check the manual parameter in the URL.

Template Not Found

If you see a "Template not found!" message:

• Ensure the file exists in the /templates/ folder.
• Check the template parameter in the URL.

Frequently Asked Questions

Q: What is the default manual?

A: The default manual is help.md.

Q: How can I preview my Markdown files?

A: Simply save the .md file in the /manual/ folder and access it via the URL.

Q: Can I use custom CSS in templates?

A: Yes, you can edit or create custom templates in the /templates/ folder to include your CSS.

Contact

For support or feedback, contact us at:

• Email: support@logiceverything.com
• Website: https://logiceverything.com