Fix titles in API docs (via new Panino)
This commit is contained in:
parent
55d57fd30d
commit
e4aa77dc3f
21 changed files with 45 additions and 30 deletions
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
The API doc build takes a look a source Javascript files in the _lib_ directory, and turns it into HTML output in the _api_ directory. It uses [Panino](https://github.com/gjtorikian/panino-docs) to perform the conversion.
|
||||
|
||||
For any questions, please see that repo.
|
||||
For any questions on the build system, please see that repo.
|
||||
|
||||
# Building
|
||||
|
||||
|
|
@ -15,14 +15,3 @@ In this directory, just run:
|
|||
npm install
|
||||
node build.js
|
||||
|
||||
# Build File
|
||||
|
||||
Here's a breakdown of what the arguments in _build.js_ are doing:
|
||||
|
||||
`--path=srcPath`: The location of the Ace source
|
||||
`-o=../api/`: The location of the output
|
||||
`-a=./additionalObjs.json`: A list of URLs to use for "missing objects" that the documentation requires
|
||||
`-i=index.md`: The location of the Ace index/landing page
|
||||
`-t=Ace API`: The title of the documentation
|
||||
`--skin=./resources/ace/`: The location of all the templates and design
|
||||
`-s`: Choose to split each class into its own file
|
||||
|
|
@ -2,6 +2,7 @@
|
|||
"name": "ace-api",
|
||||
"version": "0.1.0",
|
||||
"dependencies": {
|
||||
"panino" : ">=2.0.1"
|
||||
"panino" : ">=2.0.1",
|
||||
"asset-smasher": "0.2.0"
|
||||
}
|
||||
}
|
||||
|
|
@ -18,7 +18,7 @@ mixin head
|
|||
-if (isIndex)
|
||||
title #{title}
|
||||
-else
|
||||
title #{title} - #{fileName}
|
||||
title #{classId} - #{title}
|
||||
|
||||
meta(name="generator", content="c9-doc-build")
|
||||
meta(name="description", content="Ace API documentation for the online code editor.")
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue