verdnatura-mirror
/
loopback
mirror of https://github.com/strongloop/loopback.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #13 from strongloop/doc_edits 

API Doc Style / Formatting
This commit is contained in:
Ritchie Martori 2013-08-27 08:44:04 -07:00
parent c604c708cf d1b228b5cc
commit 989e9f398c
6 changed files with 621 additions and 482 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs.json
View File

@ -6,6 +6,7 @@
"docs/gettingstarted.md", "docs/gettingstarted.md",
"docs/resources.md", "docs/resources.md",
"docs/concepts.md", "docs/concepts.md",
{"title": "API", "depth": 2},
"docs/api.md", "docs/api.md",
"docs/rest.md" "docs/rest.md"
] ]

1072
docs/api.md
View File

File diff suppressed because it is too large Load Diff

4
docs/concepts.md
View File

@ -1,5 +1,9 @@
##Concepts ##Concepts
###SDKs
**PLACEHOLDER FOR SDK INTRO**
###Model ###Model
LoopBack is centered around models. A model is an object that encapsulates data. A model is usually named after its real life counterpart. Like its real life counterpart a model has properties or attributes. LoopBack is centered around models. A model is an object that encapsulates data. A model is usually named after its real life counterpart. Like its real life counterpart a model has properties or attributes.

18
docs/intro.md
View File

@ -1,13 +1,13 @@
##LoopBack ##LoopBack
v1.0.0 **v1.0.0**
###Introduction > **Introduction**
>
LoopBack is a mobile backend framework that puts you in control. As a mobile developer you decide where to run your mobile backend - in the cloud or on permise. > LoopBack is a mobile backend framework that puts you in control. As a mobile developer you decide where to run your mobile backend - in the cloud or on permise.
LoopBack is built on open source Node.js and leverages the power of Node and the community that stands behind Node. > LoopBack is built on open source Node.js and leverages the power of Node and the community that stands behind Node.
>
LoopBack is here to help you develop mobile applications with rich functionality and data that is in your datacenter and the cloud. > LoopBack is here to help you develop mobile applications with rich functionality and data that is in your datacenter and the cloud.
Since LoopBack is built on open source, it is highly extensible and familiar with developers already using Node. > Since LoopBack is built on open source, it is highly extensible and familiar with developers already using Node.
Node.js leverages Javascript. The ubiquituous language of the web that most developers have already had familiarity with it's ease of use. > Node.js leverages Javascript. The ubiquituous language of the web that most developers have already had familiarity with it's ease of use.
--- ---

2
docs/quickstart.md
View File

@ -21,3 +21,5 @@ $ slc run app
**Step 5** Try out the various REST apis by clicking the button below. **Step 5** Try out the various REST apis by clicking the button below.
<a href="http://localhost:3000/explorer" class="status btn btn-primary">Explore the REST APIs</a> <a href="http://localhost:3000/explorer" class="status btn btn-primary">Explore the REST APIs</a>
---

6
docs/rest.md
View File

@ -1,9 +1,9 @@
#Model REST API ## REST API
LoopBack automatically binds a model to a list of HTTP endpoints that provide REST APIs for CRUD and other remote LoopBack automatically binds a model to a list of HTTP endpoints that provide REST APIs for CRUD and other remote
operations. operations.
##Sample Model ### Sample Model
We use the following `Location` model as an example to illustrate generated REST APIs. We use the following `Location` model as an example to illustrate generated REST APIs.
@ -83,7 +83,7 @@ The remoting is defined using the following properties:
- returns: Description of the return value - returns: Description of the return value
- http: Binding to the HTTP endpoint - http: Binding to the HTTP endpoint
##Generated APIs ###Generated APIs
###create ###create