More docs

leetsheet.scroll

@@ -1,4 +1,5 @@
 buildCsv
+buildJson
 title Scroll LeetSheet
 
 header.scroll

parsers/aftertext.parsers

@@ -344,6 +344,8 @@ aftertextColorParser
  extends aftertextStyleParser
  catchAllAtomType cssAnyAtom
  string property color
+ example
+  color blue
 
 aftertextOnclickParser
  popularity 0.000217

parsers/assertions.parsers

@@ -34,6 +34,9 @@ assertIgnoreBelowErrorsParser
 assertHtmlEqualsParser
  extends abstractAssertionParser
  string kind equal
+ example
+  <b></b>
+  assertHtmlEquals <b></b>
  javascript
   areEqual(actual, expected) {
     return actual === expected
@@ -44,6 +47,9 @@ assertHtmlEqualsParser
 assertBuildIncludesParser
  extends abstractAssertionParser
  string kind include
+ example
+  buildCsv
+  assertBuildIncludes virginica
  javascript
   areEqual(actual, expected) {
     return actual.includes(expected)

parsers/container.parsers

@@ -2,6 +2,8 @@ scrollContainerParser
  popularity 0.000096
  cue container
  description A centered HTML div.
+ example
+  container 600px
  catchAllAtomType cssLengthAtom
  extends abstractAftertextParser
  boolean isHtml true

parsers/css.parsers

@@ -2,6 +2,8 @@ buildCssParser
  popularity 0.000048
  description Compile to CSS file.
  extends abstractBuildTwoCommandParser
+ example
+  buildCss
 
 cssAnyAtom
  extends codeAtom
@@ -15,6 +17,9 @@ cssParser
  popularity 0.007211
  extends abstractScrollParser
  description A style tag.
+ example
+  css
+   body { color: red;}
  cueFromId
  catchAllParser cssLineParser
  catchAllAtomType cssAnyAtom
@@ -47,6 +52,8 @@ scrollBackgroundColorParser
  extends abstractScrollParser
  cue background
  catchAllAtomType cssAnyAtom
+ example
+  background red
  javascript
   buildHtml() {
    return `<style>html, body { background: ${this.content};}</style>`
@@ -70,6 +77,8 @@ scrollFontParser
  cue font
  atoms cueAtom fontFamilyAtom
  catchAllAtomType cssAnyAtom
+ example
+  font Slim
  javascript
   buildHtml() {
    const font = this.content === "Slim" ? "Helvetica Neue; font-weight:100;" : this.content
@@ -80,6 +89,8 @@ quickCssParser
  popularity 0.007524
  description Make a CSS tag.
  extends abstractQuickIncludeParser
+ example
+  style.css
  atoms urlAtom
  pattern ^[^\s]+\.(css)$
  javascript

parsers/date.parsers

@@ -35,6 +35,9 @@ printDateParser
  // If not present computes the date from the file's ctime.
  description Print published date.
  boolean isPopular true
+ example
+  date 1/11/2019
+  printDate
  javascript
   buildHtml() {
    return `<div class="printDateParser">${this.day}</div>`

parsers/delimited.parsers

@@ -1,5 +1,7 @@
 buildCsvParser
  popularity 0.000096
+ example
+  buildCsv
  description Compile to CSV file.
  extends abstractBuildOneCommandParser
 

parsers/dinkus.parsers

@@ -18,6 +18,8 @@ horizontalRuleParser
  cue ---
  description A horizontal rule.
  extends abstractDinkusParser
+ example
+  ---
  javascript
   buildHtml() {
    return `<hr>`
@@ -28,6 +30,8 @@ scrollDinkusParser
  cue ***
  description A dinkus. Breaks section.
  boolean isPopular true
+ example
+  ***
  extends abstractDinkusParser
  javascript
   dinkus = "*"
@@ -43,5 +47,7 @@ endOfPostDinkusParser
  description End of post dinkus.
  boolean isPopular true
  cue ****
+ example
+  ****
  javascript
   dinkus = "⁂"

parsers/documentation.parsers

@@ -4,6 +4,10 @@ belowAsCodeParser
  string bindTo next
  extends abstractScrollParser
  catchAllAtomType integerAtom
+ example
+  belowAsCode
+  iris
+   printTable
  cueFromId
  javascript
   method = "next"
@@ -71,6 +75,9 @@ belowAsHtmlParser
  extends belowAsCodeParser
  description Displays html output of next particle in a code block.
  cueFromId
+ example
+  belowAsHtml
+  # Hello world
  javascript
   get code() {
    return this.selectedParticles.filter(p => p.buildHtml).map(p => p.buildHtml()).join("\n")
@@ -79,6 +86,9 @@ belowAsHtmlParser
 aboveAsHtmlParser
  description Displays html output of previous particle in a code block.
  extends belowAsHtmlParser
+ example
+  # Hello world
+  aboveAsHtml
  javascript
   method = "previous"
   reverse = true

parsers/headers.parsers

@@ -19,6 +19,8 @@ h1Parser
  popularity 0.017918
  description An html h1 tag.
  extends abstractHeaderParser
+ example
+  # Hello world
  boolean isArticleContent true
  cue #
  boolean isPopular true
@@ -29,6 +31,8 @@ h2Parser
  popularity 0.005257
  description An html h2 tag.
  extends abstractHeaderParser
+ example
+  ## Hello world
  boolean isArticleContent true
  cue ##
  boolean isPopular true
@@ -39,6 +43,8 @@ h3Parser
  popularity 0.001085
  description An html h3 tag.
  extends abstractHeaderParser
+ example
+  ### Hello world
  boolean isArticleContent true
  cue ###
  javascript
@@ -47,6 +53,8 @@ h3Parser
 h4Parser
  popularity 0.000289
  description An html h4 tag.
+ example
+  #### Hello world
  extends abstractHeaderParser
  cue ####
  javascript
@@ -55,6 +63,8 @@ h4Parser
 h5Parser
  description An html h5 tag.
  extends abstractHeaderParser
+ example
+  ##### Hello world
  cue #####
  javascript
   tag = "h5"

parsers/html.parsers

@@ -37,6 +37,8 @@ quickIncludeHtmlParser
  popularity 0.007524
  description Include an HTML file.
  extends abstractQuickIncludeParser
+ example
+  body.html
  atoms urlAtom
  pattern ^[^\s]+\.(html|htm)$
  javascript
@@ -59,6 +61,8 @@ abstractHtmlParser
 scrollBrParser
  popularity 0.000096
  cue br
+ example
+  br 2
  description A break.
  extends abstractScrollParser
  catchAllAtomType integerAtom
@@ -84,6 +88,8 @@ htmlInlineParser
  extends abstractHtmlParser
  atoms htmlAnyAtom
  boolean isHtml true
+ example
+  <h1>Inline HTML</h1>
  pattern ^<
  description Inline HTML.
  boolean isPopular true

parsers/images.parsers

@@ -2,6 +2,9 @@ captionAftertextParser
  popularity 0.003207
  description An image caption.
  cue caption
+ example
+  map.png
+   caption A map.
  extends scrollParagraphParser
  boolean isPopular true
 
@@ -91,6 +94,8 @@ scrollImageParser
 quickImageParser
  popularity 0.005788
  extends scrollImageParser
+ example
+  screenshot.png
  atoms urlAtom
  pattern ^[^\s]+\.(jpg|jpeg|png|gif|webp|svg|bmp)
  int atomIndex 0

parsers/javascript.parsers

@@ -3,6 +3,8 @@ quickScriptParser
  description Make a Javascript tag.
  extends abstractQuickIncludeParser
  atoms urlAtom
+ example
+  script.js
  pattern ^[^\s]+\.(js)$
  javascript
   buildHtml() {

parsers/leetsheet.parsers

@@ -86,18 +86,26 @@ printScrollLeetSheetParser
   getNote() {
     return ""
   }
-  buildCsv() {
+  get docs() {
     const rows = this.sortDocs(this.parsersToDocument).map(obj => {
-      const {id, isPopular, description, popularity, category} = obj
+      const {id, isPopular, description, popularity, category, examples, cue} = obj
+      const example = examples.length ? examples[0].subparticlesToString() : cue
       return {
         id,
         isPopular,
         description,
         popularity,
+        example,
         category
       }
     })
-    return new Particle(this.root.lodash.sortBy(rows, "isPopular")).asCsv
+    return this.root.lodash.sortBy(rows, "isPopular")
+  }
+  buildJson() {
+    return JSON.stringify(this.docs, undefined, 2)
+  }
+  buildCsv() {
+    return new Particle(this.docs).asCsv
   }
 
 printparsersLeetSheetParser

parsers/music.parsers

@@ -15,4 +15,6 @@ quickSoundParser
  extends scrollMusicParser
  atoms urlAtom
  pattern ^[^\s]+\.(mp3|wav|ogg|aac|m4a|flac)
- int atomIndex 0
+ int atomIndex 0
+ example
+  sipOfCoffee.m4a

parsers/permalinks.parsers

@@ -2,6 +2,8 @@ baseUrlParser
  popularity 0.009188
  description Required for RSS and OpenGraph.
  extends abstractUrlSettingParser
+ example
+  baseUrl https://hub.scroll.pub/
 
 permalinkParser
  popularity 0.000265

parsers/theme.parsers

@@ -6,6 +6,8 @@ scrollThemeParser
  popularity 0.007524
  boolean isPopular true
  cue theme
+ example
+  theme gazette
  extends abstractScrollParser
  catchAllAtomType scrollThemeAtom
  description A collection of simple themes.

parsers/video.parsers

@@ -17,6 +17,8 @@ scrollVideoParser
 quickVideoParser
  popularity 0.000024
  extends scrollVideoParser
+ example
+  spirit.mp4
  atoms urlAtom
  pattern ^[^\s]+\.(mp4|webm|avi|mov)
  int atomIndex 0