Bläddra i källkod

[docs] Change heading depth (#2401)

Guy Carmeli 6 år sedan
förälder
incheckning
b38ab7ba71
No account linked to committer's email address
2 ändrade filer med 14 tillägg och 13 borttagningar
  1. 13
    13
      docs/docs/Navigation.md
  2. 1
    0
      scripts/generate-js-doc.js

+ 13
- 13
docs/docs/Navigation.md Visa fil

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

+ 1
- 0
scripts/generate-js-doc.js Visa fil

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