File tree 5 files changed +47
-6
lines changed
5 files changed +47
-6
lines changed Original file line number Diff line number Diff line change @@ -24,6 +24,7 @@ DerivedData
24
24
/html
25
25
/docset
26
26
/docset-installed.txt
27
+ /site /docs
27
28
28
29
# build
29
30
/target
Original file line number Diff line number Diff line change @@ -22,7 +22,7 @@ project.
22
22
23
23
## API Reference
24
24
25
- * TODO: add API reference link *
25
+ A full API reference is available [ here ] ( https://geofire-ios.firebaseapp.com/docs/ )
26
26
27
27
## Quick Start
28
28
Original file line number Diff line number Diff line change 1
1
#! /bin/bash
2
+ set -e
3
+
4
+ DIR=" $( cd " $( dirname " ${BASH_SOURCE[0]} " ) " && pwd ) "
2
5
3
6
echo " Generating appledocs..."
4
7
appledoc --project-name " GeoFire for iOS" \
5
8
--project-company " Firebase" \
6
9
--company-id com.firebase \
10
+ --no-create-docset \
7
11
--create-html \
8
- --keep-intermediate \
9
- --output . \
12
+ --output " $DIR /site/" \
10
13
--search-undocumented-doc \
11
- ./GeoFire/API/* .h
14
+ --exit-threshold 2 \
15
+ " $DIR " /GeoFire/API/* .h
12
16
13
- echo " Removing temporary files"
14
- rm -r docset-installed.txt docset
17
+ echo " Renaming output folder"
18
+ rm -r " $DIR /site/docs"
19
+ mv " $DIR /site/html" " $DIR /site/docs"
Original file line number Diff line number Diff line change
1
+ {
2
+ "firebase" : " geofire-ios" ,
3
+ "public" : " site" ,
4
+ "ignore" : [
5
+ " firebase.json" ,
6
+ " **/.*" ,
7
+ " **/node_modules/**"
8
+ ]
9
+ }
Original file line number Diff line number Diff line change
1
+ <!DOCTYPE html>
2
+ < html >
3
+ < head >
4
+ < title > GeoFire for iOS</ title >
5
+ </ head >
6
+
7
+ < body style ="width: 800px; margin: auto; ">
8
+ < h1 style ="text-align: center; "> GeoFire for iOS</ h1 >
9
+
10
+ < h2 > API Reference</ h2 >
11
+ < p >
12
+ A full API reference for GeoFire for iOS is available < a href ="docs/index.html "> here</ a > .
13
+ </ p >
14
+
15
+ < h2 > Source Code</ h2 >
16
+ < p >
17
+ GeoFire for iOS is open source and available on < a href ="https://github.com/firebase/geofire-ios "> GitHub</ a >
18
+ </ p >
19
+
20
+ < h2 > Other version</ h2 >
21
+ < p >
22
+ Other versions of GeoFire are available fore < a href ="https://github.com/firebase/geofire "> JavaScript</ a > and < a
23
+ href ="https://github.com/firebase/geofire-java "> Android/Java</ a > .
24
+ </ p >
25
+ </ body >
26
+ </ html >
You can’t perform that action at this time.
0 commit comments