typographist-static-devtools
v2.1.1
Published
Typographist static devtools is part of the [Typographist](https://github.com/typography-gang/typographist) ecosystem. It is necessary to develop and debug UI static websites with the help of vertical rhythm.
Downloads
31
Readme
Typographist static devtools
Typographist static devtools is part of the Typographist ecosystem. It is necessary to develop and debug UI static websites with the help of vertical rhythm.
Installation
If you do not know what Typographist is, you should familiarize yourself with its documentation, and then return back here.
Use yarn or npm
yarn add typographist-static-devtoolsnpm i typographist-static-devtoolsConnect Typographist-static-devtools
Js
requireJs
const RhythmToggleButton = require("typographist-static-devtools");es6 modules
import RhythmToggleButton from "typographist-static-devtools";umd
<script type="text/javascript" src="typographist-static-devtools.js" />Css
requireJs
require("typographist-static-devtools/devtools.css");es6 modules
import "typographist-static-devtools/devtools.css";<link rel="stylesheet" href="/devtools.css">How to use?
Rake the main tag and add a button to the topic.
<body>
<div id="root">
<!-- you markup -->
</div>
</body>const button = new RhythmToggleButton();
button.addTo("#root");Fluid rhythm
/* If your use */
:root {
@root (fluid);
}Switch the rhythm to fluid
const button = new RhythmToggleButton({
root: "fluid"
});Hide button
const button = new RhythmToggleButton({
display: "none"
});Keyboard shortcuts
If you do not feel comfortable switching the rhythm step by step by pressing the button, you can use keyboard shortcuts
| command | keys | | ------------------ | :---: | | show single rhythm | s + r | | show double rhythm | d + r | | hide rhythm | o + r |
License
MIT License
Copyright (c) 2018 Maxim Alyoshin
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.