Skip to content

Commit

Permalink
Initial port to gitbook
Browse files Browse the repository at this point in the history
  • Loading branch information
Joseph Hager committed Mar 31, 2015
1 parent 9109a94 commit e717f40
Show file tree
Hide file tree
Showing 143 changed files with 6,789 additions and 3,048 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
.DS_STORE
target/
_book
pom.xml.tag
pom.xml.releaseBackup
pom.xml.versionsBackup
Expand Down
25 changes: 0 additions & 25 deletions Guardfile

This file was deleted.

1 change: 1 addition & 0 deletions LANGS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* [English](en)
32 changes: 27 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,32 @@
RoboVM Documentation Project
===========
# RoboVM Documentation Project

To generate the docs run
## Development

Docs are written in [markdown](http://daringfireball.net/projects/markdown/syntax), and rendered using [gitbook](https://github.com/GitbookIO/gitbook).

Make sure you have [npm](https://www.npmjs.com/) installed and run

```bash
npm install gitbook -g
gitbook serve .
```
mvn package

This will start a server, watch for changes to files, and automatically refresh the browser when the build completes.

## Deployment

The book can be built for deployment using

```bash
gitbook build .
```

This project also comes with a `guard` file which can be used to get a live preview when editing the asciidoc source files. For instructions see: http://asciidoctor.org/docs/editing-asciidoc-with-live-preview/.
There are options for rendering to pdf and epub, but the default is to output a website in the _book directory.

## Contributing

This book has been written by various RoboVM contributors.

If you notice any errors or would like to help out, please use Github issues to discuss any changes so that work will not be duplicated.

All content is licensed under the [Creative Commons Attribution Non Commercial Share Alike 4.0 license](http://creativecommons.org/licenses/by-nc-sa/4.0/).
13 changes: 13 additions & 0 deletions book.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"gitbook": ">=2.0.0",
"theme": "./theme",
"title": "RoboVM User Guide",
"structure": {
"readme": "introduction.md"
},
"variables": {
"appVersion": "1.0.0",
"osxVersion": "10.9",
"xcodeVersion": "6.x"
}
}
17 changes: 17 additions & 0 deletions en/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Summary

* [Getting Started](getting-started/introduction.md)
* [Getting Started with Eclipse](getting-started/eclipse.md)
* [Getting Started with IntelliJ](getting-started/intellij.md)
* [Getting Started with Maven](getting-started/maven.md)
* [Getting Started with Gradle](getting-started/gradle.md)
* [Project and Code Structure](getting-started/structure.md)
* [Samples](samples.md)
* [Configuration Reference](configuration.md)
* [Advanced Topics](advanced-topics/introduction.md)
* [Under the Hood](advanced-topics/compilation.md)
* [Using RAM Disks](advanced-topics/ramdisks.md)
* [Using the Latest Nightly Build](advanced-topics/nightlies.md)
* [Using the Latest Nightly Build](advanced-topics/nightlies.md)
* [The Bro Java to Native Bridge](advanced-topics/bro.md)
* [Command Line Usage](advanced-topics/commandline.md)
Loading

0 comments on commit e717f40

Please sign in to comment.