servius/sukr
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc(highlight): add examples

Browse Source
This commit is contained in:
Timothy DeHerrera
2026-01-31 17:30:35 -07:00
parent ea9830f04b
commit 10fd93452b
1 changed files with 115 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

117
docs/content/features/syntax-highlighting.md
View File

@@ -37,6 +37,117 @@ fn main() {
| HTML | `html` | | HTML | `html` |
| CSS | `css` | | CSS | `css` |
| Markdown | `markdown`, `md` | | Markdown | `markdown`, `md` |
| C | `c` |
## Examples
### Rust
```rust
fn main() {
println!("Hello, world!");
}
```
### Python
```python
def greet(name: str) -> str:
return f"Hello, {name}!"
```
### JavaScript
```javascript
const greet = (name) => `Hello, ${name}!`;
```
### TypeScript
```typescript
function greet(name: string): string {
return `Hello, ${name}!`;
}
```
### Go
```go
func main() {
fmt.Println("Hello, world!")
}
```
### Bash
```bash
#!/bin/bash
echo "Hello, $USER!"
```
### Nix
```nix
{ pkgs }:
pkgs.mkShell { buildInputs = [ pkgs.hello ]; }
```
### TOML
```toml
[package]
name = "sukr"
version = "0.1.0"
```
### YAML
```yaml
name: Build
on: [push]
jobs:
build:
runs-on: ubuntu-latest
```
### JSON
```json
{
"name": "sukr",
"version": "0.1.0"
}
```
### HTML
```html
<!DOCTYPE html>
<html>
<body>
Hello!
</body>
</html>
```
### CSS
```css
.container {
display: flex;
color: #ff79c6;
}
```
### C
```c
#include <stdio.h>
int main() {
printf("Hello!\n");
return 0;
}
```
## How It Works ## How It Works
@@ -69,9 +180,9 @@ Highlighted code uses semantic CSS classes:
The exact classes depend on the language grammar. The exact classes depend on the language grammar.
## Nix Language Support ## Injection Support
sukr includes full Nix highlighting with injection support. Bash code inside `buildPhase` and similar attributes is highlighted correctly: Some languages support injection—highlighting embedded languages. For example, Bash inside Nix strings:
```nix ```nix
stdenv.mkDerivation { stdenv.mkDerivation {
@@ -82,6 +193,8 @@ stdenv.mkDerivation {
} }
``` ```
Markdown also supports injection—code blocks inside markdown fences are highlighted with their respective languages.
## Fallback ## Fallback
Unknown languages fall back to plain `<code>` blocks without highlighting. Unknown languages fall back to plain `<code>` blocks without highlighting.