yasl-lang / docs

📚 language documentation for YASL

YASL Documentation

YASL is a small, dynamically-typed, embeddable scripting language with a familiar C-like syntax. It is written in standard C99. It is not intended for writing large applications; rather, it should be embedded in a larger C or C++ program. Of course, a fully operational interpreter for YASL is provided. See the following pages for documentation and code examples.

An online version of the interpreter, using WASM, is available here, although it may be a little out of date.

Contents

• Keywords
• Grammar
• Basic Concepts
  • Comments
  • Values and Types
  • Variables and Constants
• Statements
  • Functions Definition
  • Assert Statement
  • Echo Statement
• Expressions
  • Comprehensions
  • Operators
  • Operator Precedence Table
• Control Flow
  • Truthiness
  • Control Flow
• Variadics
• Standard Library
  • Built-in Functions
  • IO Library
  • Math Library
  • Collections Library
  • Metatable Library
• Embedding YASL
  • Introduction
• Contributing
  • Style Guide

docs's Issues

Fix minor markup errors

Decide on website versioning scheme

One potential solution is to put old docs in folders, for example:

README.md
keywords.md
...

v2/README.md
v2/keywords.md
v2/...

and just edit files for non-breaking releases

paging @CoffeeTableEspresso

Decide on theme

Probably build off an existing one, and keep it in-repo for customization.

Paging @CoffeeTableEspresso

Use Doxygen to generate documentation for C API.

Most of the work is already done here, i.e. most of the relevant files are commented already.

Still left to do:

• fix theme of HTML output for Doxygen
• integrate this with the rest of the documentation.