Skip to content
Speculator

Introduction

Speculator is a comprehensive toolkit designed to streamline the process of creating, validating, and searching technical specifications.

Built with the modern web in mind, it provides a set of modular packages that can be used independently or together to build robust specification ecosystems.

Core Packages

Section titled “Core Packages”
  • @openuji/speculator: The core pipeline for parsing and processing specifications.
  • @openuji/speculator-lint: A powerful linter to ensure consistency and correctness across your documents.
  • @openuji/speculator-search: A search engine integration to make your specifications easily discoverable.
  • @openuji/render-respec: Generate ReSpec-compatible HTML from your specification source.
  • @openuji/vocab-build: Build and manage vocabularies for your projects.

Key Features

Section titled “Key Features”
  • Extensible Pipeline: Customize the processing flow with plugins.
  • Monorepo Friendly: Designed to work seamlessly in large-scale codebases.
  • TypeScript Native: Full type safety and excellent developer experience.
  • Markdown & HTML Support: Document your specs in your preferred format.