Compare commits

...

8 Commits

Author SHA1 Message Date
Jaguar
d147ae7bb6 Fix typos (#239) 2019-08-28 21:28:52 -07:00
Lucien Greathouse
9b6ce57c79 Add notice about 0.4.x end-of-life. Closes #235. 2019-08-27 14:46:29 -07:00
Lucien Greathouse
ed85d2a327 Fix doc image links 2019-02-08 14:08:59 -08:00
Lucien Greathouse
7e5b8cadfc Update doc links 2019-01-28 15:39:52 -08:00
Lucien Greathouse
c805f4fa2d Point site URL to 0.4.x 2019-01-12 16:33:08 -08:00
Lucien Greathouse
f09d7fb0ff Update docs home to be more specific 2019-01-10 10:51:03 -08:00
Lucien Greathouse
4e918bab5e Ignore generate-docs command, should only exist on master 2019-01-09 23:20:19 -08:00
Lucien Greathouse
8e3f9b3bfd Add links to newer docs from 0.4.x docs 2019-01-09 23:16:08 -08:00
5 changed files with 23 additions and 12 deletions

1
.gitignore vendored
View File

@@ -1 +1,2 @@
/site
/generate-docs

View File

@@ -56,7 +56,7 @@ If your project is in the right place, Rojo will let you know that it was found
In Roblox Studio, open the plugins tab and find Rojo's buttons.
![Location of Rojo's plugin buttons in Roblox Studio](/images/plugin-buttons.png)
![Location of Rojo's plugin buttons in Roblox Studio](../images/plugin-buttons.png)
{: align="center" }
Press **Test Connection** to verify that the plugin can communicate with the dev server. Watch the Output panel for the results.
@@ -64,7 +64,7 @@ Press **Test Connection** to verify that the plugin can communicate with the dev
!!! info
If you see an error message, return to the previous steps and make sure that the Rojo dev server is running.
![Rojo error in Roblox Studio Output](/images/connection-error.png)
![Rojo error in Roblox Studio Output](../images/connection-error.png)
{: align="center" }
After your connection was successful, press **Sync In** to move code from the filesystem into Studio, or use **Toggle Polling** to have Rojo automatically sync in changes as they happen.

View File

@@ -1,6 +1,16 @@
# Home
This is the documentation home for Rojo.
This is the documentation home for **Rojo 0.4.x**.
**Rojo** is a flexible multi-tool designed for creating robust Roblox projects.
!!! warning
Rojo 0.4.x has reached end-of-life as of the release of Rojo 0.5.0 on August 27, 2019.
This documentation is a work in progress, and is incomplete.
Upgrading to Rojo 0.5.0 is strongly recommended to get new features and continue getting support.
Available versions of these docs:
* [Latest version from `master` branch](https://rojo.space/docs/latest)
* [0.5.x](https://rojo.space/docs/0.5.x)
* [0.4.x](https://rojo.space/docs/0.4.x)
**Rojo** is a tool designed to enable Roblox developers to use professional-grade software engineering tools.
This documentation is a continual work in progress. If you find any issues, please file an issue on [Rojo's issue tracker](https://github.com/rojo-rbx/rojo/issues)!

View File

@@ -5,7 +5,7 @@ This page aims to describe how Rojo turns files on the filesystem into Roblox ob
Any directory on the filesystem will turn into a `Folder` instance in Roblox, unless that folder matches the name of a service or other existing instance. In those cases, that instance will be preserved.
## Scripts
Rojo can represent `ModuleScript`, `Script`, and `LocalScript` objects. The default script type is `ModuleScript`, since most scripts in well-structued Roblox projects will be modules.
Rojo can represent `ModuleScript`, `Script`, and `LocalScript` objects. The default script type is `ModuleScript`, since most scripts in well-structured Roblox projects will be modules.
| File Name | Instance Type |
| -------------- | -------------- |
@@ -13,7 +13,7 @@ Rojo can represent `ModuleScript`, `Script`, and `LocalScript` objects. The defa
| `*.client.lua` | `LocalScript` |
| `*.lua` | `ModuleScript` |
If a directory contains a file named `init.server.lua`, `init.client.lua`, or `init.lua`, that folder will be transformed into a `*Script` instance with the conents of the `init` file. This can be used to create scripts inside of scripts.
If a directory contains a file named `init.server.lua`, `init.client.lua`, or `init.lua`, that folder will be transformed into a `*Script` instance with the contents of the `init` file. This can be used to create scripts inside of scripts.
For example, this file tree:
@@ -23,7 +23,7 @@ For example, this file tree:
Will turn into these instances in Roblox:
![Example of Roblox instances](/images/sync-example.png)
![Example of Roblox instances](images/sync-example.png)
## Models
Rojo supports a JSON model format for representing simple models. It's designed for instance types like `BindableEvent` or `Value` objects, and is not suitable for larger models.
@@ -62,4 +62,4 @@ JSON model files are fairly strict; any syntax errors will cause the model to fa
}
]
}
```
```

View File

@@ -1,5 +1,5 @@
site_name: Rojo Documentation
site_url: https://lpghatguy.github.io/rojo/
site_url: https://lpghatguy.github.io/rojo/0.4.x
repo_name: LPGhatguy/rojo
repo_url: https://github.com/LPGhatguy/rojo
@@ -9,7 +9,7 @@ theme:
primary: 'Red'
accent: 'Red'
pages:
nav:
- Home: index.md
- Why Rojo?: why-rojo.md
- Getting Started: