Browse Source

[docs] Change heading depth (#2401)

Guy Carmeli 6 years ago
parent
commit
b38ab7ba71
No account linked to committer's email address
2 changed files with 14 additions and 13 deletions
  1. 13
    13
      docs/docs/Navigation.md
  2. 1
    0
      scripts/generate-js-doc.js

+ 13
- 13
docs/docs/Navigation.md View File

@@ -1,6 +1,6 @@
1 1
 <a name="Navigation"></a>
2 2
 
3
-## Navigation
3
+# Navigation
4 4
 
5 5
 * [Navigation](#Navigation)
6 6
     * [.registerContainer(containerName, getContainerFunc)](#Navigation+registerContainer)
@@ -21,7 +21,7 @@
21 21
 
22 22
 <a name="Navigation+registerContainer"></a>
23 23
 
24
-### navigation.registerContainer(containerName, getContainerFunc)
24
+## navigation.registerContainer(containerName, getContainerFunc)
25 25
 Every screen component in your app must be registered with a unique name. The component itself is a traditional React component extending React.Component.
26 26
 
27 27
 
@@ -35,7 +35,7 @@ Every screen component in your app must be registered with a unique name. The co
35 35
 
36 36
 <a name="Navigation+setRoot"></a>
37 37
 
38
-### navigation.setRoot(root)
38
+## navigation.setRoot(root)
39 39
 Reset the navigation stack to a new screen (the stack root is changed).
40 40
 
41 41
 
@@ -48,7 +48,7 @@ Reset the navigation stack to a new screen (the stack root is changed).
48 48
 
49 49
 <a name="Navigation+setDefaultOptions"></a>
50 50
 
51
-### navigation.setDefaultOptions(options)
51
+## navigation.setDefaultOptions(options)
52 52
 Set default options to all screens. Useful for declaring a consistent style across the app.
53 53
 
54 54
 
@@ -61,7 +61,7 @@ Set default options to all screens. Useful for declaring a consistent style acro
61 61
 
62 62
 <a name="Navigation+setOptions"></a>
63 63
 
64
-### navigation.setOptions(containerId, options)
64
+## navigation.setOptions(containerId, options)
65 65
 Change a containers navigation options
66 66
 
67 67
 
@@ -75,7 +75,7 @@ Change a containers navigation options
75 75
 
76 76
 <a name="Navigation+showModal"></a>
77 77
 
78
-### navigation.showModal(params)
78
+## navigation.showModal(params)
79 79
 Show a screen as a modal.
80 80
 
81 81
 
@@ -88,7 +88,7 @@ Show a screen as a modal.
88 88
 
89 89
 <a name="Navigation+dismissModal"></a>
90 90
 
91
-### navigation.dismissModal(containerId)
91
+## navigation.dismissModal(containerId)
92 92
 Dismiss a modal by containerId. The dismissed modal can be anywhere in the stack.
93 93
 
94 94
 
@@ -101,7 +101,7 @@ Dismiss a modal by containerId. The dismissed modal can be anywhere in the stack
101 101
 
102 102
 <a name="Navigation+dismissAllModals"></a>
103 103
 
104
-### navigation.dismissAllModals()
104
+## navigation.dismissAllModals()
105 105
 Dismiss all Modals
106 106
 
107 107
 
@@ -109,7 +109,7 @@ Dismiss all Modals
109 109
 
110 110
 <a name="Navigation+push"></a>
111 111
 
112
-### navigation.push(containerId, params)
112
+## navigation.push(containerId, params)
113 113
 Push a new screen into this screen's navigation stack.
114 114
 
115 115
 
@@ -123,7 +123,7 @@ Push a new screen into this screen's navigation stack.
123 123
 
124 124
 <a name="Navigation+pop"></a>
125 125
 
126
-### navigation.pop(containerId, params)
126
+## navigation.pop(containerId, params)
127 127
 Pop a container from the stack, regardless of it's position.
128 128
 
129 129
 
@@ -137,7 +137,7 @@ Pop a container from the stack, regardless of it's position.
137 137
 
138 138
 <a name="Navigation+popTo"></a>
139 139
 
140
-### navigation.popTo(containerId)
140
+## navigation.popTo(containerId)
141 141
 Pop the stack to a given container
142 142
 
143 143
 
@@ -150,7 +150,7 @@ Pop the stack to a given container
150 150
 
151 151
 <a name="Navigation+popToRoot"></a>
152 152
 
153
-### navigation.popToRoot(containerId)
153
+## navigation.popToRoot(containerId)
154 154
 Pop the container's stack to root.
155 155
 
156 156
 
@@ -163,6 +163,6 @@ Pop the container's stack to root.
163 163
 
164 164
 <a name="Navigation+events"></a>
165 165
 
166
-### navigation.events()
166
+## navigation.events()
167 167
 Obtain the events registery instance
168 168
 

+ 1
- 0
scripts/generate-js-doc.js View File

@@ -31,6 +31,7 @@ function createDocFileForClass({ className, templateData, outputDir, partial = [
31 31
     data: templateData,
32 32
     template,
33 33
     separators: separator,
34
+    'heading-depth': 1,
34 35
     partial: [...PARTIALS, ...partial]
35 36
   };
36 37
   console.log(`rendering ${className}`);