You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: notebooks/contributing.md
+18-1Lines changed: 18 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,5 +6,22 @@
6
6
1. Create a folder in `projects` with a [Clay](https://scicloj.github.io/clay/) notebook, multiple notebooks, or a book. Add a link to the scrapbook at the top of your notebooks.
7
7
You need to have a `.devcontainer` folder in it.
8
8
9
-
2. Create a [Pull Request](https://github.com/scicloj/clojure-data-tutorials/pulls) adding it at the bottom of the [table of contents](https://github.com/scicloj/clojure-data-tutorials/blob/main/notebooks/toc.edn).
9
+
2. Create a [Pull Request](https://github.com/scicloj/clojure-data-tutorials/pulls) adding our new folder at the bottom of the [table of contents](https://github.com/scicloj/clojure-data-tutorials/blob/main/notebooks/toc.edn).
10
+
11
+
You need to specify
12
+
| tag | example | description|
13
+
|-----|--------| ------- |
14
+
|:created| "2024-01-11"| creadion date of notebook|
15
+
|:title| "Machine learning - DRAFT"|title of notebook|
16
+
|:url| "projects/noj/ml.html"| entry point html file of the notebook|
17
+
|:source-path| "projects/noj/notebooks/ml.clj"| folder or file as entrypoint of the notebook|
18
+
|:folder| "projects/noj" | base folder, not needed if :souce path is a folder|
19
+
|:cmd| "clj notebooks/render.clj" | command to render notebook|
20
+
|:tags|[:noj:ml:scicloj.ml :draft]| some tags|
21
+
22
+
If `:source-path` is a folder, `:folder` is not needed
23
+
(A clay notebook can be ither a .clj fil or a folder of .clj files)
24
+
25
+
`:cmd` need to be a command, which renders your notebook into `docs/` folder
0 commit comments