Convert ADOC to WIKI

Why Convert ADOC to WIKI?

Converting AsciiDoc to Wiki format bridges the gap between structured technical documentation and collaborative web-based knowledge management. While AsciiDoc excels at creating polished, publishable documents, Wiki format is optimized for team collaboration, easy editing, and building interconnected knowledge bases.

Wiki platforms like MediaWiki, Confluence, and DokuWiki are designed for collaborative editing and knowledge sharing. By converting your AsciiDoc documentation to Wiki format, you make it accessible to a broader audience who may not be familiar with AsciiDoc tooling but are comfortable with wiki editing interfaces.

This conversion is particularly valuable when you need to migrate documentation to a wiki platform, enable non-technical team members to contribute, or integrate your content into an existing wiki ecosystem. Wiki format supports features like easy page interlinking, categories, templates, and version history that facilitate collaborative content management.

The converter produces MediaWiki-style markup by default, which is the most widely used wiki format. This format is compatible with Wikipedia, MediaWiki installations, and many other wiki platforms. Most wiki systems can import or adapt MediaWiki-formatted content with minimal adjustments.

Key Benefits of Converting ADOC to WIKI:

• Enable Team Collaboration: Wiki platforms allow multiple users to edit and contribute simultaneously
• Web-Native Publishing: Wiki content is immediately accessible through web browsers
• Built-in Version Control: Wiki systems include revision history and comparison features
• Easy Cross-Linking: Wiki markup makes it simple to create internal links between pages
• Lower Barrier to Entry: Wiki syntax is often simpler for non-technical contributors
• Template Support: Wiki platforms offer templates for consistent formatting
• Platform Integration: Convert content for Wikipedia, Confluence, or internal wikis

Practical Examples

Example 1: Converting a Documentation Page

Input AsciiDoc file (install.adoc):

= Installation Guide
:author: Development Team
:toc:

== Prerequisites

Before installing, ensure you have:

* Python 3.8 or higher
* pip package manager
* Git (optional)

== Installation Steps

. Clone the repository
. Run `pip install -r requirements.txt`
. Configure the settings file

TIP: Use a virtual environment for isolation.

== Configuration

[source,yaml]
----
database:
  host: localhost
  port: 5432
----

Output Wiki file (install.wiki):

= Installation Guide =

== Prerequisites ==

Before installing, ensure you have:

* Python 3.8 or higher
* pip package manager
* Git (optional)

== Installation Steps ==

# Clone the repository
# Run pip install -r requirements.txt
# Configure the settings file

{{Tip|Use a virtual environment for isolation.}}

== Configuration ==


database:
  host: localhost
  port: 5432

Example 2: Converting a Feature Comparison Table

Input AsciiDoc file (comparison.adoc):

== Feature Comparison

[cols="1,1,1", options="header"]
|===
|Feature
|Free Plan
|Premium Plan

|Storage
|5 GB
|100 GB

|Users
|Up to 3
|Unlimited

|Support
|Email only
|24/7 Priority
|===

NOTE: Prices subject to change.

Output Wiki file (comparison.wiki):

== Feature Comparison ==

{| class="wikitable"
|-
! Feature
! Free Plan
! Premium Plan
|-
| Storage
| 5 GB
| 100 GB
|-
| Users
| Up to 3
| Unlimited
|-
| Support
| Email only
| 24/7 Priority
|}

{{Note|Prices subject to change.}}

Example 3: Converting an API Reference

Input AsciiDoc file (api.adoc):

== API Reference

=== GET /users

Returns a list of all users.

.Request Headers
[horizontal]
Authorization:: Bearer token required
Content-Type:: application/json

.Response Example
[source,json]
----
{
  "users": [
    {"id": 1, "name": "Alice"},
    {"id": 2, "name": "Bob"}
  ]
}
----

See also: <<authentication,Authentication Guide>>

Output Wiki file (api.wiki):

== API Reference ==

=== GET /users ===

Returns a list of all users.

'''Request Headers'''
; Authorization : Bearer token required
; Content-Type : application/json

'''Response Example'''

{
  "users": [
    {"id": 1, "name": "Alice"},
    {"id": 2, "name": "Bob"}
  ]
}


See also: [[Authentication Guide]]

Frequently Asked Questions (FAQ)

Q: Which wiki format does this converter produce?

A: Our converter produces MediaWiki-style markup by default, which is the most widely used wiki format. This format is compatible with MediaWiki, Wikipedia, and many other wiki platforms. Most wiki systems can import or adapt MediaWiki-formatted content.

Q: Will my AsciiDoc tables convert properly to Wiki format?

A: Yes, AsciiDoc tables are converted to wiki table syntax with appropriate formatting. Column headers, cell alignment, and spanning cells are preserved where supported by wiki syntax. Complex table features may require minor manual adjustments after conversion.

Q: How are code blocks handled during conversion?

A: AsciiDoc source code blocks are converted to wiki syntaxhighlight tags, preserving the programming language specification for proper syntax highlighting. Inline code is converted to appropriate wiki code formatting tags.

Q: Can I convert AsciiDoc includes and conditionals?

A: AsciiDoc include directives and conditional content are processed during conversion. The included content is merged into the output, while conditional blocks are evaluated based on default attributes. For complex conditional logic, you may need to pre-process the AsciiDoc file.

Q: How are AsciiDoc admonitions converted?

A: AsciiDoc admonitions (TIP, NOTE, WARNING, CAUTION, IMPORTANT) are converted to wiki template calls. For example, a TIP block becomes a Tip template. Ensure your target wiki has these templates defined, or create them to match your styling needs.

Q: Will cross-references and links work after conversion?

A: Internal cross-references are converted to wiki internal links using double bracket notation. External URLs are preserved as external links. You may need to adjust link targets if your wiki page names differ from the original reference IDs.

Q: Can I convert multiple AsciiDoc files at once?

A: Yes, you can upload and convert multiple ADOC files simultaneously. Each file is processed independently and converted to its own wiki file. For multi-file documentation projects, consider converting all files and then organizing them within your wiki structure.

Q: Is the converted content compatible with Confluence?

A: While our converter produces MediaWiki syntax, Confluence uses its own wiki format. You may need to use Confluence's import tools or make adjustments for full compatibility. Many elements like headings, lists, and basic formatting translate well between wiki formats.