-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve docs
- Loading branch information
Showing
5 changed files
with
46 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,16 @@ | ||
module.exports = ` | ||
Welcome to Tapspace.js API documentation. | ||
Build your zoomable application with the tools documented here. | ||
For older versions, see [Tapspace.js API docs index](https://taataa.github.io/tapspace/api/) | ||
Choose version: [v1](https://taataa.github.io/tapspace/api/) – [v2](#) | ||
This document follows these naming conventions: \`ClassName\`, \`namespace\`, \`.CONSTANT\`, \`.classMethod()\`, \`:instanceProperty\`, \`:instanceMethod()\`, \`[optionalParameter]\`, and \`optionalProperty?\`. | ||
**Welcome** to Tapspace.js API documentation. | ||
Build your zoomable application with the classes and methods documented here. | ||
This document is generated with [yamdog](https://github.com/axelpale/yamdog). | ||
See also: [Introduction](https://taataa.github.io/tapspace/) – [Examples](https://taataa.github.io/tapspace/#examples) – [Tutorial](https://taataa.github.io/tapspace/tutorial/) - [Glossary](https://taataa.github.io/tapspace/glossary/v2/) - [GitHub](https://github.com/taataa/tapspace) | ||
You might want to look [examples](https://taataa.github.io/tapspace/#examples) | ||
and [tutorial](https://taataa.github.io/tapspace/tutorial/) to learn how to combine | ||
classes and method calls to build your first zoomable applications. Rely on the API documentation | ||
when you are ready to get wild. | ||
This document is generated with [yamdog](https://github.com/axelpale/yamdog). | ||
**Naming convention** of the document: \`ClassName\`, \`namespace\`, \`.CONSTANT\`, \`.classMethod()\`, \`:instanceProperty\`, \`:instanceMethod()\`, \`[optionalParameter]\`, and \`optionalProperty?\`. | ||
See also: [Introduction](https://taataa.github.io/tapspace/) – [Examples](https://taataa.github.io/tapspace/#examples) – [Tutorial](https://taataa.github.io/tapspace/tutorial/) - [Glossary](https://taataa.github.io/tapspace/glossary/v2/) - [GitHub](https://github.com/taataa/tapspace) | ||
` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters