github/overleaf
1
0
Fork 0
mirror of https://github.com/overleaf/overleaf.git synced 2024-11-14 20:40:17 -05:00
Code Issues Projects Releases Packages Wiki Activity

Update README.md

Browse source
This commit is contained in:
James Allen 2014-02-18 17:08:26 +00:00
parent 85275a9373
commit df4516ce95
1 changed files with 45 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

56
services/clsi/README.md
View file

@ -36,17 +36,51 @@ The CLSI is based on a JSON API.
#### Example Request #### Example Request
(Note that valid JSON should not contain any comments like the example below).
POST /project/<project-id>
```javascript ```javascript
{ {
"options": { compile: {
"compiler": "lualatex" # Can be latex, pdflatex, xelatex or lualatex "options": {
"timeout": 40 # How many seconds to wait before killing the process. Default is 60. // Which compiler to use. Can be latex, pdflatex, xelatex or lualatex
}, "compiler": "lualatex"
"rootResourcePath": "main.tex", # The main file to run LaTeX on // How many seconds to wait before killing the process. Default is 60.
# An array of files to include in the compilation "timeout": 40
"resources": [{ },
"path": "main.tex", // The main file to run LaTeX on
"content": "\\documentclass{article}\n\\begin{document}\nHello World\n\\end{document}" "rootResourcePath": "main.tex",
}] // An array of files to include in the compilation. May have either the content
// passed directly, or a URL where it can be downlaoded.
"resources": [{
"path": "main.tex",
"content": "\\documentclass{article}\n\\begin{document}\nHello World\n\\end{document}"
}, {
"path": "image.png",
"url": "www.example.com/image.png",
"modified": 123456789 // Unix time since epoch
}]
} }
}
```
You can specify any project-id in the URL, and the files and LaTeX environment will be persisted between requests.
URLs will be downloaded and cached until provided with a more recent modified date.
#### Example Response
```javascript
{
"compile": {
"status": "success",
"outputFiles": [{
"type": "pdf",
"url": "http://localhost:3013/project/<project-id>/output/output.pdf"
}, {
"type": "log",
"url": "http://localhost:3013/project/<project-id>/output/output.log"
}]
}
}
``` ```