Design Systems Crafted with Swanky.
Swanky Docs compliments any way that you choose to work. See what’s possible!
Build wonderful docs, right out of the box.
Fabulous features
With the power of Swanky processors you can easily document your work. Choose from our commonly used ready made processors or write your own.
Swanky ships with a beautifully crafted documentation theme that allows you to get cracking on what matters most. However, as with all things Swanky you can create your own. View our step by step guide on developing a custom theme and see how easy it is!
Snippets allow you to write once and use anywhere. Snippets can contain HTML, CSS and JavaScript. They can be used anywhere by placing the snippet in your content.
Swanky is built using the latest es6 JavaScript features backed by the powerful v8 node engine and finally delivered to you using Webpack for the ultimate optimisations, performance and of course... developer happiness.
Design Systems Crafted with Swanky.
Get up and running in 5 minutes.
Swanky Docs is a module for Node.js. There are convenient installers for MacOS, Windows and Linux.
This is a tool to help you quickly scaffold your Swanky Docs Site, Pages, Snippets and Themes.
npm i -g swanky-cliFollow the prompts to select the options most appropriate for you. This will install all the necessary dependencies and start up your Swanky Docs site.
swanky
For the full list of Swanky Docs options and features visit the User Guide.