Shins
Shins development continues at
Overview
Shins is a port of the Slate documentation tool to JavaScript/Node.js. It allows for the creation of beautiful static documentation for APIs. Shins aims to be compatible with the version of Slate it is based on.
Features
- Port of the Slate documentation tool
- Ability to add custom logos and specify logo URL
- Option to use different layout template
- Ability to specify output filename
- Support for css-style attributes in markdown
- Ability to specify different source and pub directories
- Local checking and automatic re-rendering of files
- Easy deployment to GitHub Pages or own web server
- Dockerfile included for easy building and running in Docker
- Support for multiple Shins pages or portal
- Ability to use Promises with error handling
- Custom CSS and inline resources options for easier synchronization with future releases
- Express
Express.js is a simple Node.js framework for single, multi-page, and hybrid web applications.
- SCSS
SCSS is a preprocessor scripting language that extends the capabilities of CSS by adding features such as variables, nesting, and mixins. It allows developers to write more efficient and maintainable CSS code, and helps to streamline the development process by reducing repetition and increasing reusability.
- Documentation
Documentation themes are built specifically for writing technical and product documentation. They are normally written and maintained in Markdown. The often include a navigation menu, search bar, clear headings, semantic document structure and clean typography.
- Stylelint
Stylelint is a modern linter for CSS that helps you avoid errors and enforce consistent styling conventions. It provides rules for detecting errors and warnings, and can be configured to match your specific project's requirements.
