Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,13 +63,10 @@ should give the output:
array_47new.janet
```

If such a file already exists, you can simply append your example code
to the existing file.

When building the site, the new examples will be included in the
generated documentation. Make sure that your example has correct janet
syntax, as syntax errors will cause the entire site to not build. If
the example has valid syntax (has a 0 exit code when loaded with
`janet -k example/my-fn.janet`), there may be a bug in the mendoza
janet syntax highlighter in which case please open a bug in mendoza.
If such a file already exists, you can simply append your example code the existing file.

When building the site, the new examples will be included in the generated documentation. Make
sure that your example has correct janet syntax, as syntax errors will cause the entire site
to not build. If the example has valid syntax (has a 0 exit code when loaded with
`janet -k example/my-fn.janet`), there may be a bug in the mendoza janet syntax
highlighter and you open a bug in mendoza.
2 changes: 1 addition & 1 deletion content/api/array.mdz
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
(import ./gen-docs :as gen-docs)
(import ../gen-docs :as gen-docs)

{:title "Array Module"
:nav-title "array"
Expand Down
2 changes: 1 addition & 1 deletion content/api/buffer.mdz
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
(import ./gen-docs :as gen-docs)
(import ../gen-docs :as gen-docs)

{:title "Buffer Module"
:nav-title "buffer"
Expand Down
2 changes: 1 addition & 1 deletion content/api/bundle.mdz
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
(import ./gen-docs :as gen-docs)
(import ../gen-docs :as gen-docs)

{:title "Bundle Module"
:nav-title "bundle"
Expand Down
2 changes: 1 addition & 1 deletion content/api/debug.mdz
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
(import ./gen-docs :as gen-docs)
(import ../gen-docs :as gen-docs)

{:title "Debug Module"
:nav-title "debug"
Expand Down
2 changes: 1 addition & 1 deletion content/api/ev.mdz
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
(import ./gen-docs :as gen-docs)
(import ../gen-docs :as gen-docs)

{:title "Event Module"
:nav-title "ev"
Expand Down
2 changes: 1 addition & 1 deletion content/api/ffi.mdz
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
(import ./gen-docs :as gen-docs)
(import ../gen-docs :as gen-docs)

{:title "FFI Module"
:nav-title "ffi"
Expand Down
2 changes: 1 addition & 1 deletion content/api/fiber.mdz
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
(import ./gen-docs :as gen-docs)
(import ../gen-docs :as gen-docs)

{:title "Fiber Module"
:nav-title "fiber"
Expand Down
2 changes: 1 addition & 1 deletion content/api/file.mdz
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
(import ./gen-docs :as gen-docs)
(import ../gen-docs :as gen-docs)

{:title "File Module"
:nav-title "file"
Expand Down
10 changes: 10 additions & 0 deletions content/api/filewatch.mdz
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
(import ../gen-docs :as gen-docs)

{:title "Filewatch Module"
:nav-title "filewatch"
:template "docpage.html"}
---

## Index

@gen-docs/gen-prefix[filewatch/]
4 changes: 2 additions & 2 deletions content/api/index.mdz
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
(import ./gen-docs :as gen-docs)
(import ../gen-docs :as gen-docs)

{:title "Core API"
:nav-title "API"
:nav-title "Core API"
:order 3
:template "docpage.html"
:permalinks ["doc.html"] }
Expand Down
2 changes: 1 addition & 1 deletion content/api/int.mdz
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
(import ./gen-docs :as gen-docs)
(import ../gen-docs :as gen-docs)

{:title "Integer Types Module"
:nav-title "int"
Expand Down
11 changes: 11 additions & 0 deletions content/api/janet.mdz
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
(import ../gen-docs :as gen-docs)

{:title "Janet Module"
:nav-title "janet"
:template "docpage.html"}
---

## Index

@gen-docs/gen-prefix[janet/]

2 changes: 1 addition & 1 deletion content/api/math.mdz
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
(import ./gen-docs :as gen-docs)
(import ../gen-docs :as gen-docs)

{:title "Math Module"
:nav-title "math"
Expand Down
2 changes: 1 addition & 1 deletion content/api/misc.mdz
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
(import ./gen-docs :as gen-docs)
(import ../gen-docs :as gen-docs)

{:title "Top Level Bindings"
:nav-title "misc"
Expand Down
2 changes: 1 addition & 1 deletion content/api/module.mdz
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
(import ./gen-docs :as gen-docs)
(import ../gen-docs :as gen-docs)

{:title "Module Module"
:nav-title "module"
Expand Down
2 changes: 1 addition & 1 deletion content/api/net.mdz
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
(import ./gen-docs :as gen-docs)
(import ../gen-docs :as gen-docs)

{:title "Net Module"
:nav-title "net"
Expand Down
2 changes: 1 addition & 1 deletion content/api/os.mdz
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
(import ./gen-docs :as gen-docs)
(import ../gen-docs :as gen-docs)

{:title "OS Module"
:nav-title "os"
Expand Down
2 changes: 1 addition & 1 deletion content/api/parser.mdz
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
(import ./gen-docs :as gen-docs)
(import ../gen-docs :as gen-docs)

{:title "Parser Module"
:nav-title "parser"
Expand Down
2 changes: 1 addition & 1 deletion content/api/peg.mdz
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
(import ./gen-docs :as gen-docs)
(import ../gen-docs :as gen-docs)

{:title "PEG Module"
:nav-title "peg"
Expand Down
13 changes: 0 additions & 13 deletions content/api/spork/argparse.mdz

This file was deleted.

13 changes: 0 additions & 13 deletions content/api/spork/base64.mdz

This file was deleted.

13 changes: 0 additions & 13 deletions content/api/spork/cjanet.mdz

This file was deleted.

13 changes: 0 additions & 13 deletions content/api/spork/cron.mdz

This file was deleted.

13 changes: 0 additions & 13 deletions content/api/spork/data.mdz

This file was deleted.

13 changes: 0 additions & 13 deletions content/api/spork/fmt.mdz

This file was deleted.

13 changes: 0 additions & 13 deletions content/api/spork/generators.mdz

This file was deleted.

13 changes: 0 additions & 13 deletions content/api/spork/htmlgen.mdz

This file was deleted.

13 changes: 0 additions & 13 deletions content/api/spork/http.mdz

This file was deleted.

22 changes: 0 additions & 22 deletions content/api/spork/index.mdz

This file was deleted.

73 changes: 0 additions & 73 deletions content/api/spork/infix.mdz

This file was deleted.

13 changes: 0 additions & 13 deletions content/api/spork/misc.mdz

This file was deleted.

13 changes: 0 additions & 13 deletions content/api/spork/msg.mdz

This file was deleted.

Loading