Skip to Content
Getting Started with Maraikka

Getting Started with Maraikka

Welcome to Maraikka! This guide will help you get up and running with the platform quickly and efficiently.

System Requirements

Before installing Maraikka, ensure your system meets the following minimum requirements:

Minimum Requirements

  • Operating System: Windows 10+, macOS 10.15+, or Linux (Ubuntu 18.04+)
  • RAM: 4GB minimum, 8GB recommended
  • Storage: 1GB available disk space
  • Internet Connection: Required for initial setup and updates
  • RAM: 16GB for optimal performance
  • Storage: SSD with 10GB+ available space
  • Browser: Chrome 90+, Firefox 88+, Safari 14+, or Edge 90+

Installation Options

Maraikka can be installed through multiple methods to suit your preferences:

  1. Download the installer from maraikka.com/download 
  2. Run the installer and follow the setup wizard
  3. Launch Maraikka from your applications folder or desktop shortcut

Option 2: Package Managers

Windows (Chocolatey)

choco install maraikka

macOS (Homebrew)

brew install --cask maraikka

Linux (Snap)

sudo snap install maraikka

Option 3: Docker

docker run -p 3000:3000 maraikka/maraikka:latest

Option 4: Build from Source

For developers who want to customize Maraikka or contribute to the project:

git clone https://github.com/puzzlers-labs/maraikka.git
cd maraikka
npm install
npm run build
npm start

See the Development Guide for detailed build instructions.

First Launch

When you first launch Maraikka, you’ll be greeted with the setup wizard:

  1. Welcome Screen: Introduction to Maraikka’s features
  2. Account Setup: Create your Maraikka account or sign in
  3. Workspace Creation: Set up your first documentation workspace
  4. Template Selection: Choose from predefined templates or start blank

Basic UI Overview

Main Interface Components

  • Dashboard: Overview of your documentation projects
  • Projects: Access to all your documentation workspaces
  • Templates: Pre-built documentation templates
  • Settings: Account and application preferences

Content Editor

  • Rich Text Editor: WYSIWYG interface for content creation
  • Markdown Mode: Raw markdown editing with live preview
  • Component Library: Reusable content blocks and widgets
  • Media Manager: Upload and organize images, videos, and files

Preview Panel

  • Live Preview: Real-time rendering of your content
  • Responsive View: Test how content appears on different devices
  • Collaboration: See team member cursors and comments in real-time

Keyboard Shortcuts

Essential shortcuts to boost your productivity:

  • Ctrl/Cmd + N: New document
  • Ctrl/Cmd + S: Save document
  • Ctrl/Cmd + P: Preview mode
  • Ctrl/Cmd + K: Quick command palette
  • Ctrl/Cmd + /: Toggle markdown mode

Creating Your First Documentation

Step 1: Create a New Project

  1. Click “New Project” from the dashboard
  2. Choose a template or start from scratch
  3. Enter your project name and description
  4. Select your team members (if applicable)

Step 2: Set Up Your Structure

  1. Create your main sections using the sidebar
  2. Add pages within each section
  3. Configure navigation and hierarchy
  4. Set up your table of contents

Step 3: Start Writing

  1. Use the rich text editor for intuitive content creation
  2. Add headings, lists, links, and media
  3. Insert code blocks with syntax highlighting
  4. Use callouts for important information

Step 4: Customize and Publish

  1. Apply your brand colors and styling
  2. Configure SEO settings
  3. Set up your domain (if applicable)
  4. Publish your documentation

Next Steps

Now that you have Maraikka installed and understand the basics:

  • Explore the Features section to learn about advanced capabilities
  • Check out the User Guide for detailed workflows
  • Join our community for tips, tricks, and support
  • Consider upgrading to Maraikka Pro for additional features

Troubleshooting

Common Installation Issues

”Installation Failed” Error

  • Ensure you have administrator privileges
  • Temporarily disable antivirus software
  • Check available disk space

”Cannot Connect to Server” Error

  • Verify your internet connection
  • Check firewall settings
  • Try using a VPN if corporate networks block access

Performance Issues

  • Close unnecessary applications
  • Restart Maraikka
  • Check system requirements

Getting Help

If you encounter issues:

  1. Check our FAQ section
  2. Search our community forum 
  3. Contact support at support@maraikka.com
  4. Report bugs on GitHub Issues 

Ready to dive deeper? Continue to the Features section to explore what Maraikka can do!

Content Editing FeaturesUser Guide