Skip to content

Commit

Permalink
a few fixes (#163)
Browse files Browse the repository at this point in the history
  • Loading branch information
richard authored Sep 3, 2023
1 parent dda2144 commit 8f1c4d9
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 31 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,14 @@ This documentation gets deployed to: https://docs.coronalabs.com/

Engine source can be found [here](https://github.com/coronalabs/corona)

Documentation lives in `markdown/` directory. Note that it does not use GitHub flavored markdown, but rather its own flavor.
Documentation lives in `markdown/` directory. Note that it does not use GitHub flavored Markdown, but rather its own flavor.

Plugin documentation lives in submodule. Mind it when checking out. Submodule documentation is auto-generated and not intended to be edited manually.
Plugin documentation lives in a submodule. Mind it when checking out. Submodule documentation is auto-generated and not intended to be edited manually.

To build documentation yourself from `bin` directory run `lua build.lua`. Make sure Lua has LFS (Lua File System) accessible.

To build docs with docker (same as production) run
```sh
docker run --rm -it -v "$(pwd)":/src --workdir /src/bin --entrypoint /usr/bin/lua coronalabs/docs build.lua
```
```

Loading

0 comments on commit 8f1c4d9

Please sign in to comment.