Skip to content

Commit 3935766

Browse files
authored
Update contributing.md
1 parent 14841bd commit 3935766

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

notebooks/contributing.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,22 @@
66
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.
77
You need to have a `.devcontainer` folder in it.
88

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
26+
1027

0 commit comments

Comments
 (0)