Refactor NbBlock

.github/workflows/docs.yml

@@ -9,7 +9,7 @@ jobs:
       - uses: actions/checkout@v2
       - name: install nim
         id: install_nim
-        uses: iffy/install-nim@v3
+        uses: iffy/install-nim@v5
       - name: install library dependencies
         run: nimble install -y
       - name: install doc dependencies

.github/workflows/netlify_build_docs.yml

@@ -8,10 +8,12 @@ jobs:
   tests:
     runs-on: ubuntu-latest
     steps:
+      - name: apt install
+        run: sudo apt install -y libpcre3 libblas-dev liblapack-dev
       - uses: actions/checkout@v2
       - name: install nim
         id: install_nim
-        uses: iffy/install-nim@v3
+        uses: iffy/install-nim@v5
       - name: install library dependencies
         run: nimble install -y
       - name: install doc dependencies

.github/workflows/test.yml

@@ -10,16 +10,16 @@ jobs:
     strategy:
       matrix:
         nim:
-          - '1.6.x'
           - 'stable'
           - 'devel'
       fail-fast: false
     name: Nim ${{ matrix.nim }}
     steps:
       - uses: actions/checkout@v3
-      - uses: jiro4989/setup-nim-action@v1.4.3
+      - uses: jiro4989/setup-nim-action@v2.2.2
         with:
           nim-version: ${{ matrix.nim }}
+      - run: sudo apt install libpcre3 libpcre3-dev
       - run: nimble -y install
       - run: nimble docsdeps
       - run: nimble test

README.md

@@ -1,4 +1,3 @@
-
 # nimib 🐳 - nim 👑 driven ⛵ publishing ✍
 
 Nimib provides an API to convert your Nim code and its outputs to html documents.
@@ -50,8 +49,6 @@ provides syntax highlighting of embedded languages in nimib documents (eg. markd
 First have a look at the following html document: [hello.html](https://pietroppeter.github.io/nimib/hello.html)
 
 This was produced with `nim r docsrc/hello`, where [docsrc/hello.nim](https://github.com/pietroppeter/nimib/blob/main/docsrc/hello.nim) is:
-
-
 ```nim
 import strformat, strutils
 import nimib
@@ -100,8 +97,6 @@ nbText:
 nbSave
 
 ```
-
-
 ### Other examples of usage
 
 in this repo:
@@ -228,16 +223,11 @@ that allow to override the above value, skip the config file or other options.
 
 All the options available can be seen by running any nimib file with option `nbHelp`
 (execution will stop after `nbInit`).
-
-
-
 ```nim
 import osproc
-withDir nb.srcDir:
+withDir nb.doc.srcDir:
   echo execProcess("nim r --verbosity:0 --hints:off --warnings:off hello --nbHelp")
 ```
-
-
 ```
 Nimib options:
 
@@ -248,12 +238,9 @@ Nimib options:
   --nbHomeDir,  --nimibHomeDir              set homeDir as relative (to CfgDir) or absolute; overrides config 
   --nbFilename, --nimibFilename             overrides name of output file (e.g. somefile --nbFilename:othername.html)
   --nbShow,     --nimibShow                 open in browser at the end of nbSave
-```
-
-
-
 
 
+```
 The value of options are available in `nb.options` field which also
 tracks further options in `nb.options.other: seq[tuple[kind: CmdLineKind; name, value: string]]`.
 
@@ -371,5 +358,4 @@ because I made a [package](https://github.com/pietroppeter/nimoji) for that and
 ### why the Q & A?
 
 because [someone made it into an art form](https://github.com/oakes/vim_cubed#q--a)
-and they tell me [imitation is the sincerest form of flattery](https://www.goodreads.com/quotes/558084-imitation-is-the-sincerest-form-of-flattery-that-mediocrity-can)
-
+and they tell me [imitation is the sincerest form of flattery](https://www.goodreads.com/quotes/558084-imitation-is-the-sincerest-form-of-flattery-that-mediocrity-can)

docsrc/allblocks.nim

@@ -4,17 +4,17 @@ import std/[strutils, strformat]
 
 nbInit
 
-var nbToc: NbBlock
+var nbToc: NbText
 
 template addToc =
-  newNbBlock("nbText", false, nb, nbToc, ""):
-    nbToc.output = "## Table of Contents:\n\n"
+  nbToc = newNbText(text="## Table of Contents:\n\n")
+  nb.add nbToc
 
-template nbCodeBlock(name:string) =
+template nbCodeBlock(name: string) =
   let anchorName = name.toLower.replace(" ", "-")
   nbText "<a name = \"" & anchorName & "\"></a>\n### " & name & "\n\n---"
   # see below, but any number works for a numbered list
-  nbToc.output.add "1. <a href=\"#" & anchorName & "\">" & name & "</a>\n"
+  nbToc.text.add "1. <a href=\"#" & anchorName & "\">" & name & "</a>\n"
 
 nbText: """
 > This nimib document provides a brief description and example for 
@@ -120,7 +120,7 @@ The `typ` parameter specifies the video's MIME type, and is optional!
 """
 
 nimibCode:
-  nbVideo(url="media/bad_apple!!.mp4", typ="video/mp4")
+  nbVideo(url="media/bad_apple!!.mp4", filetype="video/mp4")
 
 nbCodeBlock: "nbAudio"
 nbText: """

docsrc/cheatsheet.nim

@@ -1,5 +1,5 @@
 ## Markdown cheatsheet with nimib 
-import nimib, std/strutils
+import nimib, std/[strutils, strformat, json]
 
 nbInit
 nbText: """
@@ -15,34 +15,36 @@ nbText: """
 """
 
 # customize source highlighting:
-nb.context["highlight"] = """
+nb.doc.context["highlight"] = %"""
 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/default.min.css">
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
 <script>hljs.initHighlightingOnLoad();</script>"""
 
+
 # a custom text block that shows markdown source
-template nbTextWithSource*(body: untyped) =
-  newNbBlock("nbTextWithSource", false, nb, nb.blk, body):
-    nb.blk.output = body
-  nb.blk.context["code"] = body
+newNbBlock(NbTextWithSource of NbText):
+  toHtml:
+    result = withNewlines:
+      nbTextToHtml(blk, nb)
+      &"""<pre><code class="language-markdown">{blk.text}</code></pre>"""
 
-nb.renderPlans["nbTextWithSource"] = @["mdOutputToHtml"]
-nb.partials["nbTextWithSource"] = """{{&outputToHtml}}
-<pre><code class=\"language-markdown\">{{code}}</code></pre>"""
+template nbTextWithSource*(body: string) =
+  let blk = newNbTextWithSource(text=body)
+  nb.add blk
 
 # how to add a ToC
 var
-  nbToc: NbBlock
+  nbToc: NbText
 
 template addToc =
-  newNbBlock("nbText", false, nb, nbToc, ""):
-    nbToc.output = "# Table of Contents:\n\n"
+  nbToc = newNbText(text="# Table of Contents:\n\n")
+  nb.add nbToc
 
 template nbSection(name:string) =
   let anchorName = name.toLower.replace(" ", "-")
   nbText "<a name = \"" & anchorName & "\"></a>\n# " & name & "\n\n---"
   # see below, but any number works for a numbered list
-  nbToc.output.add "1. <a href=\"#" & anchorName & "\">" & name & "</a>\n" 
+  nbToc.text.add "1. <a href=\"#" & anchorName & "\">" & name & "</a>\n" 
 
 # here is the start of the document
 nbText """
@@ -100,7 +102,7 @@ nbTextWithSource """1. First ordered list item
 * Unordered list can use asterisks
 - Or minuses
 + Or pluses"""
-nb.blk.output = nb.blk.output.replace(dot, " ")
+nb.blk.NbTextWithSource.text = nb.blk.NbTextWithSource.text.replace(dot, " ")
 
 nbText """
 > in ordered to have the ordered sublist work correctly

docsrc/far/from/home.nim

@@ -1,7 +1,7 @@
 import nimib, strutils
 nbInit
-nb.context["path_to_root"] = nb.context["path_to_root"].castStr.replace("/", r"\") # for CI since I run locally on Windows and CI runs on Linux: behaviour is the same
-nb.context["path_to_here"] = nb.context["path_to_here"].castStr.replace("/", r"\") # for CI since I run locally on Windows and CI runs on Linux: behaviour is the same
+nb.doc.context["path_to_root"] = %nb.doc.context{"path_to_root"}.getStr.replace("/", r"\") # for CI since I run locally on Windows and CI runs on Linux: behaviour is the same
+nb.doc.context["path_to_here"] = %nb.doc.context{"path_to_here"}.getStr.replace("/", r"\") # for CI since I run locally on Windows and CI runs on Linux: behaviour is the same
 nb.partials["document"] = """
 <html>
 <head></head>

docsrc/index.nim

@@ -12,7 +12,7 @@ nb.title = "Nimib Docs"
 let
   repo = "https://github.com/pietroppeter/nimib"
   docs = if defined(mdOutput): "https://pietroppeter.github.io/nimib" else: "."
-  hello = read(nb.srcDir / "hello.nim".RelativeFile)
+  hello = read(nb.doc.srcDir / "hello.nim".RelativeFile)
 
 nbText: hlMdF"""
 # nimib :whale: - nim :crown: driven :sailboat: publishing :writingHand:
@@ -65,13 +65,13 @@ provides syntax highlighting of embedded languages in nimib documents (eg. markd
 
 First have a look at the following html document: [hello.html]({docs}/hello.html)
 
-This was produced with `nim r {nb.cfg.srcDir}/hello`, where [{nb.cfg.srcDir}/hello.nim]({repo}/blob/main/{nb.cfg.srcDir}/hello.nim) is:
+This was produced with `nim r {nb.doc.cfg.srcDir}/hello`, where [{nb.doc.cfg.srcDir}/hello.nim]({repo}/blob/main/{nb.doc.cfg.srcDir}/hello.nim) is:
 """.emojize
 
 
 when not defined(mdOutput):
   nbCode: discard
-  nb.blk.code = hello  # "\n" should not be needed here (fix required in rendering)
+  nb.blk.NbCode.code = hello  # "\n" should not be needed here (fix required in rendering)
 else:
   nbText &"""
 ```nim
@@ -124,7 +124,7 @@ The following are the main elements of a default nimib document:
 * (optional) latex rendering through [katex](https://katex.org/) (see below)
 * a header with navigation to a home page, a minimal title and an automatic detection of github repo (with link)
 * a footer with a "made with nimib" line and a `Show source` button that shows the full source to create the document.
-* (optional) possibility to create a markdown version of the same document (see this document for an example: [{nb.cfg.srcDir}/index.nim]({repo}/blob/main/{nb.cfg.srcDir}/index.nim))
+* (optional) possibility to create a markdown version of the same document (see this document for an example: [{nb.doc.cfg.srcDir}/index.nim]({repo}/blob/main/{nb.doc.cfg.srcDir}/index.nim))
 
 Customization over the default is mostly achieved through nim-mustache or changing
 `NbDoc` and `NbBlock` elements (see below api).
@@ -210,7 +210,7 @@ All the options available can be seen by running any nimib file with option `nbH
 
 nbCode:
   import osproc
-  withDir nb.srcDir:
+  withDir nb.doc.srcDir:
     echo execProcess("nim r --verbosity:0 --hints:off --warnings:off hello --nbHelp")
 
 let renderProcType = "type NbRenderProc = proc (doc: var NbDoc, blk: var NbBlock) {. nimcall .}"
@@ -338,7 +338,7 @@ and they tell me [imitation is the sincerest form of flattery](https://www.goodr
 """.emojize
 
 when defined(mdOutput):
-  nb.filename = "../README.md"
+  nb.doc.filename = "../README.md"
   nbSave
 else:
   nbSave

docsrc/nolan.nim

@@ -1,5 +1,5 @@
 import nimib
-import strutils, sequtils, strformat
+import strutils, sequtils, strformat, json
 
 nbInit
 nbText: """
@@ -11,7 +11,7 @@ nbText: """
 >
 > It reorders a **Limerick** according to Nolan's [Memento film structure](https://en.wikipedia.org/wiki/Memento_(film)#Film_structure).
 """
-let filename_variant = nb.filename.replace(".html", "_no_source.html")
+let filename_variant = nb.doc.filename.replace(".html", "_no_source.html")
 let iChange = nb.blocks.len
 nbText:fmt"""
 > Click on `Show Source` at the bottom to see the nim file that generates this document.
@@ -48,11 +48,11 @@ nbSave
 # save another document without source to test the opt-out of Show Source feature
 nbText: "---\n> This is how we can remove the `Show Source` functionality"
 nbCode:
-  nb.context["no_source"] = true
+  nb.doc.context["no_source"] = %true
 # we will generate this last block to change a previous block and then remove it
 nbText:fmt"""
-> To see the variant with Show Source [click here]({(nb.filename.AbsoluteFile).relPath})
+> To see the variant with Show Source [click here]({(nb.doc.filename.AbsoluteFile).relPath})
 """
-nb.blocks[iChange] = nbDoc.blocks.pop
-nb.filename = filename_variant
+nb.blocks[iChange] = nb.blocks.pop
+nb.doc.filename = filename_variant
 nbSave

docsrc/numerical.nim

@@ -1,16 +1,16 @@
 #remember to run also with -d:numericalDefaultStyle
-import nimib, strformat, strutils
+import nimib, strformat, strutils, json
 nbInit
 nb.useLatex
 let
-  filename_default_style = nb.filename.replace(".html", "_default_style.html")
-  default_style = nb.context["stylesheet"]
+  filename_default_style = nb.doc.filename.replace(".html", "_default_style.html")
+  default_style = nb.doc.context["stylesheet"]
 
-nb.context["stylesheet"] = """<link rel="stylesheet" href="https://latex.now.sh/style.css">"""
+nb.doc.context["stylesheet"] = %"""<link rel="stylesheet" href="https://latex.now.sh/style.css">"""
 
 proc introText(defaultStyle = false): string =
   let otherStyle = if defaultStyle:
-    fmt"; _you are looking at default style, for custom style [click here]({(nb.filename.AbsoluteFile).relPath})_"
+    fmt"; _you are looking at default style, for custom style [click here]({(nb.doc.filename.AbsoluteFile).relPath})_"
   else:
     fmt"; _for default style [click here]({(filename_default_style.AbsoluteFile).relPath})_"
 
@@ -26,7 +26,7 @@ proc introText(defaultStyle = false): string =
 
 nbText: introText()
 # save to change later
-var blockIntroText = nb.blk
+var blockIntroText = nb.blk.NbText
 
 nbText: fmt"""# Using NumericalNim
 
@@ -128,17 +128,17 @@ $h=0.01$ | {pe y3hn[^1]} | {pe y3rk[^1]}
 
 and here is the code for this Markdown block:
 """ # right alignment of numbers does not seem to work. is this an issue of latex.css?
-let mdCode = nb.blk.code
+let mdCode = nb.blk.NbTextWithCode.code
 nbCode:
   discard
-nb.blk.code = mdCode
+nb.blk.NbCode.code = mdCode
 # add a show Markdown source. It would be nice when hovering a code block to show (on the side? how to do it on mobile?) the call code (nbText: or other)
 
 # first save with latex style
 nbSave
 
 # then save with default style
-blockIntroText.output = introText(default_style=true)
-nb.filename = filename_default_style
-nb.context["stylesheet"] = default_style 
+blockIntroText.text = introText(default_style=true)
+nb.doc.filename = filename_default_style
+nb.doc.context["stylesheet"] = default_style 
 nbSave

docsrc/pythno.nim

@@ -25,8 +25,9 @@ nbCode:
 
   echo repeat("ThisIsNotPython", 6)
 
-nb.blk.context["output"] = camel2snake(nb.blk.output)
-nb.blk.code = nb.blk.code.multiReplace([
+let codeBlock = nb.blk.NbCode
+codeBlock.output = camel2snake(codeBlock.output)
+codeBlock.code = codeBlock.code.multiReplace([
   ("proc", "def"),
   ("string", "str"),
   (";", ","), # tricky one