Inspire's front-end design system for the Web.
Explore Melodic docs »
Table of contents
- Quick start
- What's included
- Bugs and feature requests
- Copyright and license
Several quick start options are available:
- Download the latest release.
- Clone the repo:
git clone https://github.com/DWPHoldings/melodic-web.git
- Install with npm:
npm install email@example.com
- Install with yarn:
yarn add firstname.lastname@example.org
- Install with Rubygems:
gem install melodic -v 2.0.0.alpha
Read the Getting started page for information on the framework contents, templates and examples, and more.
Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this:
melodic-web/ ├── css/ │ ├── melodic.css │ ├── melodic.css.map │ ├── melodic.min.css │ ├── melodic.min.css.map │ ├── melodic-grid.css │ ├── melodic-grid.css.map │ ├── melodic-grid.min.css │ ├── melodic-grid.min.css.map │ ├── melodic-reboot.css │ ├── melodic-reboot.css.map │ ├── melodic-reboot.min.css │ └── melodic-reboot.min.css.map └── js/ ├── melodic.bundle.js ├── melodic.bundle.min.js ├── melodic.js └── melodic.min.js
We provide compiled CSS and JS (
melodic.*), as well as compiled and minified CSS and JS (
melodic.min.*). CSS source maps (
melodic.*.map) are available for use with certain browsers' developer tools. Bundled JS files (
melodic.bundle.js and minified
melodic.bundle.min.js) include Popper, but not jQuery.
Bugs and feature requests
Documentation search is powered by Algolia's DocSearch. Working on our search? Be sure to set
debug: true in the
Running documentation locally
- Run through the tooling setup to install Jekyll (the site builder) and other Ruby dependencies with
npm installto install Node.js dependencies.
- From the root
npm run docs-servein the command line.
http://localhost:9001in your browser, and voilà.
Learn more about using Jekyll by reading its documentation.
Documentation for previous releases
Previous releases and their documentation are available for download.
Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.
For transparency into our release cycle and in striving to maintain backward compatibility, Melodic is maintained under the Semantic Versioning guidelines.
See the Releases section of our GitHub project for changelogs for each release version of Melodic.
Creators and Maintainers
Thank you, Inspire Avengers and contributors.
Copyright and license
Code and documentation copyright 2011-2018 the Bootstrap Authors and Twitter, Inc. Portions copyright 2020 Inspire Energy Holdings, LLC. Code released under the MIT License. Docs released under Creative Commons.