app-dir -a: This option overrides the default directory which contains all the Handlebars templates, SCSS, and JavaScript source files. embeddable -e: This option lets you build a minimal version of the documentation without the HTML tags, so you can embed Spectacle into your own website template. start-server -s: This option starts a production server without any development options enabled that serves the contents of your -target-dir. development-mode-live -D: This option starts a development server with a file watcher and live reload, and will automatically regenerate your docs when any of your spec or app files change. development-mode -d: This option starts a development server with a file watcher, and will automatically regenerate your docs when any of your spec or app files change. Most options are self explanatory, but the following options warrant some further explanation: c, -config-file specify a custom configuration file (default: app/lib/config.js) l, -logo-file specify a custom logo file (default: null) a, -app-dir the application source directory (default: app) f, -target-file the target build HTML file (default: index.html) t, -target-dir the target build directory (default: public) P, -port-live the port number for the live reload to listen on (default: 4401) p, -port the port number for the HTTP server to listen on (default: 4400) s, -start-server start the HTTP server without any development features D, -development-mode-live start HTTP server with the file watcher and live reload (default: false) d, -development-mode start HTTP server with the file watcher (default: false) e, -embeddable omit the HTML and generate the documentation content only (default: false) J, -disable-js omit JavaScript generation (default: false) C, -disable-css omit CSS generation (default: false)
#Mailbutler sign in install#
Simply install Spectacle from npm like so:
![mailbutler sign in mailbutler sign in](https://ph-files.imgix.net/3434db39-f065-407b-b8b1-a6f00d04f2e7.jpeg)
![mailbutler sign in mailbutler sign in](https://ph-files.imgix.net/56ecd410-3e5c-453d-8030-99b585328c3f.jpeg)
#Mailbutler sign in update#
![mailbutler sign in mailbutler sign in](https://cdn-images-1.medium.com/max/1060/1*_sEElLdUJoWxxNU3R-xn4Q@2x.png)
Remote file references: Support for swagger specs split across multiple files.Markdown support: Render markdown written in any of your API descriptions.Highly configurable: Easily configurable Handlebars templates and SCSS styles so you can add your own design and flavour without going bald.OpenAPI/Swagger 2.0 support: Support for the latest OpenAPI/Swagger specification.The default layout is a three column single page, similar to those The goal of Spectacle is help you "save time and look good" by providing an extensible platform for auto generating your REST API docs. Spectacle generates beautiful static HTML5 documentation from OpenAPI/ Swagger 2.0 API specifications.