###Shins Is Not Slate
Beautiful static documentation for your API.
Shins is a port of Slate to Javascript / Nodejs, and would not be possible without all of that hard work.
- Fork the repository
- Clone the fork
- Edit source/index.html.md
npm install
node shins.js
ornode shins.js --minify
- To check locally:
node arapaho
and browse to localhost:4567 - Add, commit and push
- Then (in your fork) press this button
Or, to deploy to GitHub Pages:
- Change the setting on your fork so Github Pages are served from the root directory
- Browse to
https://{yourname}.github.io/{repository-name}
var shins = require('shins');
var options = {};
shins.render(markdownString, options, function(err, html) {
// ...
});
The err
parameter is the result of the ejs
rendering step.
- Windows is definitely supported
- Syntax highlighting in 166 languages and 68 themes (you can specify the highlighter theme to use by setting
highlighter_theme
in your slate markdown header) - For converting OpenApi / Swagger specs to Shins or Slate, see widdershins