Good documentation should include two distinct elements - a Guide and an API:
- The Guide builds concepts, providing examples, etc.
GitBook is well suited to
| /** | |
| * tryCatch - Go-style error handling for JavaScript Promises | |
| * | |
| * A utility function that bridges Promise-based and tuple-based error handling. | |
| * Perfect for avoiding try-catch blocks while maintaining explicit error handling. | |
| * | |
| * @author Jogchum Koerts | |
| * @version 2.0.0 | |
| * @created 2025-07-09 | |
| * @license MIT |
Good documentation should include two distinct elements - a Guide and an API:
GitBook is well suited to
This is a set up for projects which want to check in only their source files, but have their gh-pages branch automatically updated with some compiled output every time they push.
You want a script that does a local compile to e.g. an out/ directory. Let's call this compile.sh for our purposes, but for your project it might be npm build or gulp make-docs or anything similar.
The out/ directory should contain everything you want deployed to gh-pages. That almost always includes an index.html.
| { | |
| "name": "<%= utils.slug(projectName) %>", | |
| "version": "0.0.0", | |
| "private": true, | |
| "engines": { | |
| "node": ">=0.10.22", | |
| "npm": ">=1.3.14" | |
| }, | |
| "scripts": { | |
| "start": "<%= taskRunner !== 'none' ? taskRunner : 'node keystone.js' %>" |
| <?xml version="1.0" encoding="UTF-8" ?> | |
| <wicket:panel xmlns:wicket="http://wicket.apache.org/"> | |
| <div class="hippo-editor-field-value"> | |
| <div class="hippo-editor-field-value-container"> | |
| <div class="hippo-editor-field-subfield dialog-link"> | |
| <a wicket:id="openModalDialog" class="linefill">Click to open..</a> | |
| </div> | |
| </div> | |
| </div> | |
| <div wicket:id="modalDialog"></div> |