Skip to Content
DocumentationIntroduction

GloST Documentation

Current Version: v0.5.0

GloST (Glossed Syntax Tree) is a framework for processing multilingual text with language learning annotations using a unified/remark-style plugin system.

Getting Started

Core Guides

Language Implementation

Package Reference

Main Package

PackageDescription
glost Main entry point combining all GLOST functionality

Foundation Packages

PackageDescription
glost-coreCore types, nodes, validators, and tree utilities
glost-common Language utilities and shared code
glost-pluginsPlugin architecture and extension system
glost-utilsText manipulation utilities

Processing Infrastructure

PackageDescription
glost-processorUnified-style processor API
glost-registryPlugin discovery and validation
glost-presetsPre-configured plugin combinations
glost-cli CLI tools

Language Packages

PackageDescription
glost-th Thai language support
glost-ja Japanese language support
glost-ko Korean language support
glost-en English language support

Plugin Packages

PackageDescription
glost-transcriptionPhonetic transcription
glost-translationText translation
glost-frequency Word frequency
glost-difficulty Difficulty scoring
glost-pos Part-of-speech tagging
glost-gender Grammatical gender
glost-clause-segmenter Clause segmentation
glost-inkleInk/Inkle integration

Interface Packages

PackageDescription
glost-reactReact components for rendering
glost-dialogueDialogue syntax and helpers

Core Concepts

  • Node Types - Understanding GloST’s node hierarchy
  • Plugins - Plugin system architecture

Standards & Reference

Architecture & Philosophy

Examples

Version History

  • v0.5.0 (Current) - Release Notes - Unified-style processor, enhanced registry, CLI tools, presets
  • v0.4.0 - Extension system, multi-language support
  • v0.3.0 - Core types and document creation

Quick Example

import { glost } from '@glotblocks/glost'; import { languageLearningPreset } from '@glotblocks/glost/presets'; import { createThaiWord, createSimpleDocument } from '@glotblocks/glost'; // Create processor with preset const processor = glost() .use(languageLearningPreset) .freeze(); // Create document const document = createSimpleDocument( [ createThaiWord({ text: "สวัสดี" }), createThaiWord({ text: "ครับ" }) ], "th", "thai", { sentenceText: "สวัสดีครับ" } ); // Process const result = await processor.process(document);

Support

Last updated on