secondwheel/documentation.yml at master · thealjey/secondwheel · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
toc:
  - name: Templating
    children:
      - template
      - name: markdown
        children:
          - markdownToArray
          - markdownToJSX
      - name: jsx
        children:
          - htmlToArray
          - arrayToJSX
          - htmlToJSX
  - name: Apollo/GraphQL
    children:
      - ApolloClient
      - nextApollo
      - subscription
  - name: Hashing/Masking
    children:
      - maskPassword
      - md5
      - slug
  - name: Test Assertions
    children:
      - reactShallowStrictEqual
      - matching
      - assert
      - assertArray
      - assertString
  - name: Misc
    children:
      - env
      - cookie
      - constants
      - name: theme
        description: |
          a [documentation.js](http://documentation.js.org/) theme used to
          generate this documentation<br><br>

          Extends the [@example](http://usejsdoc.org/tags-example.html) jsdoc
          tag to support a language modifier (e.g. `@example(scss)`).<br>
          If a modifier is omitted or is not supported the language defaults to
          `'flow'`.<br>
          Follow [this link](https://prismjs.com/#languages-list) to see the
          full list of supported languages.

          The `--favicon` option must be a path to an SVG file, which will be
          rendered in the header bar as well as automatically compiled to an ICO
          file and used as a favicon.

          *Example usage*

          1. install this package - `yarn add secondwheel`
          1. add a script to *package.json*

          <pre class="language-json"><code class="language-json"><span class="token punctuation">{</span>
          <span class="token property">  "scripts"</span><span class="token operator">:</span><span class="token punctuation"> {</span>
          <span class="token property">    "docs"</span><span class="token operator">:</span><span class="token string"> "documentation build *.js -f html -t node_modules/secondwheel/theme -o docs"</span>
          <span class="token punctuation">  }</span>
          <span class="token punctuation">}</span></code></pre>
  - name: Types
    children:
      - EnvOptions
      - EnvError
      - AssertionError
      - ReactElement
      - ApolloLink
      - ApolloCache
      - Request
      - Response
      - SubscriptionPayload
      - CookieOptions
      - ApolloClientOptions