Skip to content

Commit 57dbf8f

Browse files
committed
chore: update documentation to be in markdown for the new website
1 parent 530a7f9 commit 57dbf8f

File tree

7 files changed

+186
-99
lines changed

7 files changed

+186
-99
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,6 @@ Main repository: **[ArkScript](https://github.com/ArkScript-lang/Ark)**
3838

3939
## Copyright and Licence information
4040

41-
Copyright (c) 2019-2025 Alexandre Plateau. All rights reserved.
41+
Copyright (c) 2019-2025 Lex Plateau. All rights reserved.
4242

4343
This ArkScript distribution contains no GNU GPL code, which means it can be used in proprietary projects.

draft/database/documentation/README.md

Lines changed: 28 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,20 @@
1-
@page database_module DATABASE module
1+
---
2+
title: "Database module"
3+
description: ""
4+
summary: ""
5+
date: 2025-07-23T14:25:16+02:00
6+
lastmod: 2025-07-23T14:25:16+02:00
7+
draft: false
8+
weight: 410
9+
toc: true
10+
seo:
11+
title: "" # custom title (optional)
12+
description: "" # custom description (recommended)
13+
canonical: "" # custom canonical URL (optional)
14+
noindex: false # false (default) or true
15+
---
16+
17+
{{< highlight_scripts >}}
218

319
## database:sqlite:open
420

@@ -13,9 +29,9 @@ Open a connection to a SQLite database.
1329
- [@rstefanic](https://github.com/rstefanic)
1430

1531
**Example**
16-
~~~~{.lisp}
32+
{{< highlight_arkscript >}}
1733
(let db (database:sqlite:open "test.db"))
18-
~~~~
34+
{{< /highlight_arkscript >}}
1935

2036
## database:sqlite:close
2137

@@ -30,9 +46,9 @@ Close an open connection to a SQLite database.
3046
- [@rstefanic](https://github.com/rstefanic)
3147

3248
**Example**
33-
~~~~{.lisp}
49+
{{< highlight_arkscript >}}
3450
(database:sqlite:close db)
35-
~~~~
51+
{{< /highlight_arkscript >}}
3652

3753
## database:sqlite:exec
3854

@@ -48,9 +64,9 @@ Execute a SQL query.
4864
- [@rstefanic](https://github.com/rstefanic)
4965

5066
**Example**
51-
~~~~{.lisp}
67+
{{< highlight_arkscript >}}
5268
(database:sqlite:exec db "CREATE TABLE company(id INT PRIMARY KEY NOT NULL, name TEXT NOT NULL);")
53-
~~~~
69+
{{< /highlight_arkscript >}}
5470

5571
## database:sqlite:exec_with_callback
5672

@@ -67,18 +83,17 @@ Run a SQL statement on the database and run a callback function on each row in t
6783
- [@rstefanic](https://github.com/rstefanic)
6884

6985
**Example**
70-
~~~~{.lisp}
86+
{{< highlight_arkscript >}}
7187
# CREATE TABLE user (id INT PRIMARY KEY NOT NULL, name TEXT NOT NULL);
7288
# INSERT INTO user (id, name) VALUES (1, 'Jane Doe'), (2, 'John Doe');
7389

7490
(database:sqlite:exec_with_callback
7591
db
7692
"SELECT * FROM user;"
77-
(fun (row) (print row))
78-
)
93+
(fun (row) (print row)))
7994
# ["1" "Jane Doe"]
8095
# ["2" "John Doe"]
81-
~~~~
96+
{{< /highlight_arkscript >}}
8297

8398
## database:sqlite:last_insert_row_id
8499

@@ -93,6 +108,6 @@ Get the row id of the last row inserted into the database.
93108
- [@rstefanic](https://github.com/rstefanic)
94109

95110
**Example**
96-
~~~~{.lisp}
111+
{{< highlight_arkscript >}}
97112
(database:sqlite:last_insert_row_id db)
98-
~~~~
113+
{{< /highlight_arkscript >}}

draft/json/documentation/README.md

Lines changed: 54 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,20 @@
1-
@page json_module JSON module
1+
---
2+
title: "JSON module"
3+
description: ""
4+
summary: ""
5+
date: 2025-07-23T14:25:16+02:00
6+
lastmod: 2025-07-23T14:25:16+02:00
7+
draft: false
8+
weight: 410
9+
toc: true
10+
seo:
11+
title: "" # custom title (optional)
12+
description: "" # custom description (recommended)
13+
canonical: "" # custom canonical URL (optional)
14+
noindex: false # false (default) or true
15+
---
16+
17+
{{< highlight_scripts >}}
218

319
## json:open
420

@@ -13,9 +29,9 @@ Open a file and read its content as JSON, then return it.
1329
- [@Gryfenfer97](https://github.com/Gryfenfer97)
1430

1531
**Example**
16-
~~~~{.lisp}
32+
{{< highlight_arkscript >}}
1733
(let json (json:open "test.json"))
18-
~~~~
34+
{{< /highlight_arkscript >}}
1935

2036
## json:fromString
2137

@@ -30,9 +46,9 @@ Takes a String as an argument, representing a JSON object, and return it parsed
3046
- [@Gryfenfer97](https://github.com/Gryfenfer97)
3147

3248
**Example**
33-
~~~~{.lisp}
49+
{{< highlight_arkscript >}}
3450
(let json (json:fromString "{\"hello\": \"world\", \"key\": 12}"))
35-
~~~~
51+
{{< /highlight_arkscript >}}
3652

3753
## json:get
3854

@@ -48,10 +64,10 @@ Retrieve a value from a jsonObject by its key.
4864
- [@Gryfenfer97](https://github.com/Gryfenfer97)
4965

5066
**Example**
51-
~~~~{.lisp}
67+
{{< highlight_arkscript >}}
5268
(let json (json:fromString "{\"hello\": \"world\", \"key\": 12}"))
5369
(print (json:get json "hello")) # world
54-
~~~~
70+
{{< /highlight_arkscript >}}
5571

5672
## json:toString
5773

@@ -66,10 +82,10 @@ Takes a jsonObject and transforms it into a String.
6682
- [@Gryfenfer97](https://github.com/Gryfenfer97)
6783

6884
**Example**
69-
~~~~{.lisp}
85+
{{< highlight_arkscript >}}
7086
(let json (json:fromString "{\"hello\": \"world\", \"key\": 12}"))
7187
(print (json:toString json)) # {"hello": "world", "key": 12}
72-
~~~~
88+
{{< /highlight_arkscript >}}
7389

7490
## json:set
7591

@@ -86,11 +102,11 @@ Modify a value in a jsonObject, given a key (String) and a new value.
86102
- [@Gryfenfer97](https://github.com/Gryfenfer97)
87103

88104
**Example**
89-
~~~~{.lisp}
105+
{{< highlight_arkscript >}}
90106
(let json (json:fromString "{\"hello\": \"world\", \"key\": 12}"))
91107
(json:set json "hello" 14)
92108
(print json) # {"hello": 14, "key": 12}
93-
~~~~
109+
{{< /highlight_arkscript >}}
94110

95111
## json:fromList
96112

@@ -105,18 +121,16 @@ Take a list of an even number of values, the even ones are the keys (String) and
105121
- [@Gryfenfer97](https://github.com/Gryfenfer97)
106122

107123
**Example**
108-
~~~~{.lisp}
124+
{{< highlight_arkscript >}}
109125
(let json (json:fromList [
110-
"key" "value"
111-
"keybis" 12
112-
"this_is_an_array" [1 2 3]
113-
"bool" true
114-
"subobject" (json:fromList [
115-
"a" 1
116-
"b" 2
117-
])
118-
]))
119-
~~~~
126+
"key" "value"
127+
"keybis" 12
128+
"this_is_an_array" [1 2 3]
129+
"bool" true
130+
"subobject" (json:fromList [
131+
"a" 1
132+
"b" 2 ])]))
133+
{{< /highlight_arkscript >}}
120134

121135
## json:write
122136

@@ -132,20 +146,18 @@ Take a jsonObject and a filename (String), and write the jsonObject to the file.
132146
- [@Gryfenfer97](https://github.com/Gryfenfer97)
133147

134148
**Example**
135-
~~~~{.lisp}
149+
{{< highlight_arkscript >}}
136150
(let json (json:fromList [
137-
"key" "value"
138-
"keybis" 12
139-
"this_is_an_array" [1 2 3]
140-
"bool" true
141-
"subobject" (json:fromList [
142-
"a" 1
143-
"b" 2
144-
])
145-
]))
151+
"key" "value"
152+
"keybis" 12
153+
"this_is_an_array" [1 2 3]
154+
"bool" true
155+
"subobject" (json:fromList [
156+
"a" 1
157+
"b" 2 ])]))
146158

147159
(json:write json "filename.json")
148-
~~~~
160+
{{< /highlight_arkscript >}}
149161

150162
## json:len
151163

@@ -158,16 +170,14 @@ Take a jsonObject and a filename (String), and write the jsonObject to the file.
158170
- [@Gryfenfer97](https://github.com/Gryfenfer97)
159171

160172
**Example**
161-
~~~~{.lisp}
173+
{{< highlight_arkscript >}}
162174
(let json (json:fromList [
163-
"key" "value"
164-
"keybis" 12
165-
"this_is_an_array" [1 2 3]
166-
"bool" true
167-
"subobject" (json:fromList [
168-
"a" 1
169-
"b" 2
170-
])
171-
]))
175+
"key" "value"
176+
"keybis" 12
177+
"this_is_an_array" [1 2 3]
178+
"bool" true
179+
"subobject" (json:fromList [
180+
"a" 1
181+
"b" 2 ])]))
172182
(json:len json) # 5
173-
~~~~
183+
{{< /highlight_arkscript >}}

src/bitwise/documentation/README.md

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,20 @@
1-
@page bitwise_module Bitwise module
2-
3-
For bitwise operations.
1+
---
2+
title: "Bitwise module"
3+
description: "For bitwise operations"
4+
summary: ""
5+
date: 2025-07-23T14:25:16+02:00
6+
lastmod: 2025-07-23T14:25:16+02:00
7+
draft: false
8+
weight: 410
9+
toc: true
10+
seo:
11+
title: "" # custom title (optional)
12+
description: "" # custom description (recommended)
13+
canonical: "" # custom canonical URL (optional)
14+
noindex: false # false (default) or true
15+
---
16+
17+
{{< highlight_scripts >}}
418

519
## bitwise:rshift
620

@@ -16,10 +30,10 @@ Right shifts a given number.
1630
- [@rakista112](https://github.com/rakista112)
1731

1832
**Example**
19-
~~~~{.lisp}
33+
{{< highlight_arkscript >}}
2034
(import bitwise)
2135
(print (bitwise:rshift 4096 3)) # 512
22-
~~~~
36+
{{< /highlight_arkscript >}}
2337

2438
## bitwise:lshift
2539

@@ -35,10 +49,10 @@ Left shifts a given number.
3549
- [@rakista112](https://github.com/rakista112)
3650

3751
**Example**
38-
~~~~{.lisp}
52+
{{< highlight_arkscript >}}
3953
(import bitwise)
4054
(print (bitwise:lshift 512 3)) # 4096
41-
~~~~
55+
{{< /highlight_arkscript >}}
4256

4357
## bitwise:xor
4458

@@ -54,10 +68,10 @@ Xor a number given a mask.
5468
- [@rakista112](https://github.com/rakista112)
5569

5670
**Example**
57-
~~~~{.lisp}
71+
{{< highlight_arkscript >}}
5872
(import bitwise)
5973
(print (bitwise:xor 99 13)) # 110
60-
~~~~
74+
{{< /highlight_arkscript >}}
6175

6276
## bitwise:or
6377

@@ -73,10 +87,10 @@ Compute the bitwise `a OR b` operation.
7387
- [@rakista112](https://github.com/rakista112)
7488

7589
**Example**
76-
~~~~{.lisp}
90+
{{< highlight_arkscript >}}
7791
(import bitwise)
7892
(print (bitwise:or 89 13)) # 93
79-
~~~~
93+
{{< /highlight_arkscript >}}
8094

8195
## bitwise:and
8296

@@ -92,7 +106,7 @@ Compute the bitwise `a AND b` operation.
92106
- [@rakista112](https://github.com/rakista112)
93107

94108
**Example**
95-
~~~~{.lisp}
109+
{{< highlight_arkscript >}}
96110
(import bitwise)
97111
(print (bitwise:and 89 13)) # 9
98-
~~~~
112+
{{< /highlight_arkscript >}}

0 commit comments

Comments
 (0)