Skip to content
This repository was archived by the owner on Apr 8, 2025. It is now read-only.

Commit 6d6c066

Browse files
authored
deprecate entire repository
1 parent 7b308e0 commit 6d6c066

File tree

1 file changed

+3
-63
lines changed

1 file changed

+3
-63
lines changed

README.md

+3-63
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,6 @@
1-
# React Native Firebase Docs
21

3-
This repository contains the documentation for the [RNFirebase documentation](https://invertase.io/oss/react-native-firebase).
2+
Do not use this repository, it is for the obsolete / unsupported version 5 of react-native-firebase.
43

5-
## Internal Links
4+
React Native Firebase docs are now contained directly in the react-native-firebase repository, and you may easily edit any documentation page by using the edit button at the top right of every page on rnfirebase.io
65

7-
Along with the normal markdown linking (`[text](link)`), the following markdown can also be used to make linking easier around the site:
8-
9-
### ref
10-
11-
Creates a link to a module reference file and method under the same version:
12-
13-
```
14-
[ref auth] // to /docs/<version>/auth/auth/auth
15-
[ref auth#signInWithEmailAndPassword] // to /docs/<version>/auth/reference/auth#signInWithEmailAndPassword
16-
[ref auth.User#uid] // to /docs/<version>/auth/reference/User#uid
17-
```
18-
19-
### version
20-
21-
Creates a link to the path on the documentation under the current version:
22-
23-
```
24-
[A link](version /auth/getting-started) // to /docs/<version>/auth/getting-started
25-
```
26-
27-
## Alerts
28-
29-
There is 3 types of alert, informational, warning and important:
30-
31-
```
32-
> Informational
33-
!> Warning
34-
?> Error
35-
```
36-
37-
## Headers
38-
39-
Any headers with either a double or triple hash will appear as linkable, and appear in the table of contents.
40-
41-
## Color
42-
43-
Wrapping text in color tags will wrap it in a span with the given hex code:
44-
45-
```
46-
[color #fff]White Text[/color]
47-
[color #000000]Black Text[/color]
48-
```
49-
50-
## Config
51-
52-
Each version has a custom config file (`_config.yaml`) which is converted . The contents of which will be parsed and flattened. Within the markdown, adding a flattened dot-noted path wrapped in double curly braces will print out the config:
53-
54-
```
55-
{
56-
android: {
57-
firebase: {
58-
core: '11.4.2',
59-
},
60-
},
61-
}
62-
```
63-
64-
```
65-
{{ android.firebase.core }} // 11.4.2
66-
```
6+
Thanks!

0 commit comments

Comments
 (0)