❓ Getting Started - Common Questions Answered

[alpha912]

Common Questions About OmniScript 📖

New to OmniScript? Start here! This thread answers the most common questions to help you get started quickly.

Installation

Q: How do I install OmniScript?

A: Install the CLI globally:

npm install -g omniscript-cli

Or use as a library:

npm install omniscript-parser omniscript-converters

Basic Usage

Q: How do I create my first OSF document?

A: Create a file example.osf:

@meta
title: My First Document
author: Your Name

@doc
# Hello World
This is my first OmniScript document!

## Features
- Simple syntax
- Multiple outputs
- Git-friendly

Then convert it:

osf render example.osf --format pdf

Q: What formats can I export to?

A: OSF supports:

• 📄 PDF (.pdf)
• 📝 DOCX (.docx)
• 📊 PPTX (.pptx)
• 📈 XLSX (.xlsx)
• Plus: Markdown, LaTeX, JSON, YAML

Advanced Features

Q: How do I create charts?

A: Use @chart blocks:

@chart
type: line
title: Sales Growth
data:
  labels: [Q1, Q2, Q3, Q4]
  datasets:
    - label: 2024
      values: [100, 150, 200, 300]

Q: How do I create diagrams?

A: Use @diagram blocks:

@diagram
type: flowchart
content: |
  Start -> Process -> Decision
  Decision -> End [Yes]
  Decision -> Process [No]

Documentation

Q: Where can I find complete documentation?

A: Check out:

• 🌐 Website: https://omniscriptosf.github.io
• 📖 User Guide: https://omniscriptosf.github.io/docs/user-guide
• 🔧 API Reference: https://omniscriptosf.github.io/docs/api-reference
• 💡 Examples: https://github.com/OmniScriptOSF/omniscript-examples

Still Have Questions?

💬 Ask below or create a new Q&A discussion!

Happy scripting! 🚀