syntakts

KO | EN

gitlite — search

#python #ai #typescript #deep-learning #linux #docker #nodejs #java #awesome #kubernetes #awesome-list #vue #mcp #openai

(★ 31)

Simple to use text parser and syntax highlighter for Kotlin Multiplatform

syntakts 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

### Simple to use text parser and syntax highlighter for Kotlin Multiplatform
  [![Maven Central](https://img.shields.io/maven-central/v/xyz.wingio.syntakts/syntakts-core?style=for-the-badge&logo=apachemaven&label=Latest&labelColor=black&color=blue)](https://central.sonatype.com/namespace/xyz.wingio.syntakts)
  [![GitHub Repo stars](https://img.shields.io/github/stars/wingio/syntakts?style=for-the-badge&logo=github&labelColor=black&color=red)](https://github.com/wingio/syntakts/stargazers)
  [![GitHub Sponsors](https://img.shields.io/github/sponsors/wingio?style=for-the-badge&logo=githubsponsors&labelColor=black&color=pink)](https://github.com/sponsors/wingio)

---
</div>

## Setup
```kotlin
implementation("xyz.wingio.syntakts:syntakts-core:$syntaktsVersion")
// implementation("xyz.wingio.syntakts:syntakts-compose:$syntaktsVersion")
// implementation("xyz.wingio.syntakts:syntakts-compose-material3:$syntaktsVersion")
```

## Use
Syntakts can be set up through a simple DSL:
```kotlin
val mySyntakts = syntakts<Unit> {
  rule("@([A-z])") { result, context ->
    append(result.groupValues[1]) {
      color = Color.Yellow
    }
  }
}
```

We also provide MarkdownSyntakts and BasicMarkdownSyntakts, which has some default markdown rules

### Context
Syntakts allows you to pass any class as context, this can be used to pass additional information for rendering.
If you don't need to use context you can set it to Unit

Example:
```kotlin
data class Context(
  val userMap = mapOf("1234" to "Wing")
)

val mySytankts = syntakts<Context> {
  rule("<@([0-9]+)>") { result, context ->
    val username = context.userMap[result.groupValues[1]] ?: "Unknown"
    append("@$username") {
      color = Color.Yellow
    }
  }
}
```

## Displaying

### Compose
Artifact: `syntakts-compose`

Syntakts uses AnnotatedStrings in order to display rendered text in Compose

> [!NOTE]
> 
> When creating a Syntakts instance in a composable we reccommend replacing `syntakts {}` with `rememberSyntakts {}`

Example: 
```kotlin
@Composable
fun SomeScreen() {
  val syntakts = rememberSyntakts<Unit> { /* */ }

Text(
    text = syntakts.rememberRendered("some input")
  )
}
```

### Android
Artifact: `syntakts-android`

Syntakts uses SpannableStrings in order to display rendered text on Android

Example:
```kotlin
val syntakts = syntakts<Unit> { /* */ }

findViewById<TextView>(R.id.my_text_view).render("some input", syntakts)
```

#### Clickable
Syntakts for Compose includes a ClickableText component that is neccessary in order to handle clickable text. The `syntakts-compose-material3` includes this component as well but adds support for Material 3 theming

Syntakts for Android requires that the TextView have its movementMethod set to our ClickableMovementMethod

## Attribution
Syntakts was heavily inspired by [SimpleAST](https://github.com/discord/SimpleAST), an unfortunately abandoned library that was once used in Discords android app

syntakts

syntakts 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

syntakts

syntakts 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README