yuuza/outline
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #283 from jorilallo/kb-shortcuts

Browse Source 
Shortcuts Documentation
This commit is contained in:
Jori Lallo
2017-10-01 16:40:32 -07:00
committed by GitHub
parent a954fc479c 379975253a
commit 67c4e0da3c
10 changed files with 137 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
frontend/components/Editor/plugins/KeyboardShortcuts.js
View File

@@ -22,6 +22,11 @@ export default function KeyboardShortcuts() {
return this.toggleMark(state, 'underlined');
case 'd':
return this.toggleMark(state, 'deleted');
case 'k':
return state
.transform()
.wrapInline({ type: 'link', data: { href: '' } })
.apply();
default:
return null;
}

1
frontend/components/HelpText/HelpText.js
View File

@@ -3,6 +3,7 @@ import styled from 'styled-components';
import { color } from 'styles/constants';
const HelpText = styled.p`
margin-top: 0;
color: ${color.slateDark};
`;

3
frontend/components/Key/index.js Normal file
View File

@@ -0,0 +1,3 @@
// @flow
import Key from './key';
export default Key;

19
frontend/components/Key/key.js Normal file
View File

@@ -0,0 +1,19 @@
// @flow
import styled from 'styled-components';
import { color } from 'styles/constants';
const Key = styled.kbd`
display: inline-block;
padding: 4px 6px;
font: 11px "SFMono-Regular", Consolas, "Liberation Mono", Menlo, Courier, monospace;
line-height: 10px;
color: ${color.text};
vertical-align: middle;
background-color: ${color.smokeLight};
border: solid 1px ${color.slateLight};
border-bottom-color: ${color.slate};
border-radius: 3px;
box-shadow: inset 0 -1px 0 ${color.slate};
`;
export default Key;

2
frontend/components/Layout/Layout.js
View File

@@ -69,7 +69,7 @@ type Props = {
}
@keydown('shift+/')
goToOpenKeyboardShortcuts() {
openKeyboardShortcuts() {
this.props.ui.setActiveModal('keyboard-shortcuts');
}

5
frontend/components/Modal/Modal.js
View File

@@ -18,7 +18,7 @@ type Props = {
const Modal = ({
children,
isOpen,
title = 'Untitled Modal',
title = 'Untitled',
onRequestClose,
...rest
}: Props) => {
@@ -61,7 +61,8 @@ const StyledModal = styled(ReactModal)`
overflow-x: hidden;
overflow-y: auto;
background: white;
padding: 15vh 2rem 2rem
padding: 13vh 2rem 2rem;
outline: none;
`;
const Close = styled.a`

108
frontend/scenes/KeyboardShortcuts/KeyboardShortcuts.js
View File

@@ -1,23 +1,117 @@
// @flow
import React from 'react';
import styled from 'styled-components';
import Key from 'components/Key';
import Flex from 'components/Flex';
import HelpText from 'components/HelpText';
import HtmlContent from 'components/HtmlContent';
import flatpages from 'static/flatpages';
import { convertToMarkdown } from 'utils/markdown';
const htmlContent = convertToMarkdown(flatpages.keyboard);
function KeyboardShortcuts() {
return (
<Flex column>
<HelpText>
Atlas is designed to be super fast and easy to use.
All of your usual keyboard shortcuts work here.
All of your usual keyboard shortcuts work here, and there
{"'"}
s Markdown too.
</HelpText>
<HtmlContent dangerouslySetInnerHTML={{ __html: htmlContent }} />
<h2>Navigation</h2>
<List>
<Keys><Key>e</Key></Keys>
<Label>Edit current document</Label>
<Keys><Key>m</Key></Keys>
<Label>Move current document</Label>
<Keys><Key>/</Key> or <Key>t</Key></Keys>
<Label>Jump to search</Label>
<Keys><Key>d</Key></Keys>
<Label>Jump to dashboard</Label>
<Keys><Key>⌘</Key> + <Key>/</Key></Keys>
<Label>Open this guide</Label>
</List>
<h2>Editor</h2>
<List>
<Keys><Key>⌘</Key> + <Key>Enter</Key></Keys>
<Label>Save and exit document edit mode</Label>
<Keys><Key>⌘</Key> + <Key>S</Key></Keys>
<Label>Save document and continue editing</Label>
<Keys><Key>⌘</Key> + <Key>Esc</Key></Keys>
<Label>Cancel editing</Label>
<Keys><Key>⌘</Key> + <Key>b</Key></Keys>
<Label>Bold</Label>
<Keys><Key>⌘</Key> + <Key>i</Key></Keys>
<Label>Italic</Label>
<Keys><Key>⌘</Key> + <Key>u</Key></Keys>
<Label>Underline</Label>
<Keys><Key>⌘</Key> + <Key>d</Key></Keys>
<Label>Strikethrough</Label>
<Keys><Key>⌘</Key> + <Key>k</Key></Keys>
<Label>Link</Label>
<Keys><Key>⌘</Key> + <Key>z</Key></Keys>
<Label>Undo</Label>
<Keys><Key>⌘</Key> + <Key>Shift</Key> + <Key>z</Key></Keys>
<Label>Redo</Label>
</List>
<h2>Markdown</h2>
<List>
<Keys><Key>#</Key> <Key>Space</Key></Keys>
<Label>Large header</Label>
<Keys><Key>##</Key> <Key>Space</Key></Keys>
<Label>Medium header</Label>
<Keys><Key>###</Key> <Key>Space</Key></Keys>
<Label>Small header</Label>
<Keys><Key>1.</Key> <Key>Space</Key></Keys>
<Label>Numbered list</Label>
<Keys><Key>-</Key> <Key>Space</Key></Keys>
<Label>Bulleted list</Label>
<Keys><Key>[ ]</Key> <Key>Space</Key></Keys>
<Label>Todo list</Label>
<Keys><Key>&gt;</Key> <Key>Space</Key></Keys>
<Label>Blockquote</Label>
<Keys><Key>---</Key></Keys>
<Label>Horizontal divider</Label>
<Keys><Key>{'```'}</Key></Keys>
<Label>Code block</Label>
<Keys>_italic_</Keys>
<Label>Italic</Label>
<Keys>**bold**</Keys>
<Label>Bold</Label>
<Keys>~~strikethrough~~</Keys>
<Label>Strikethrough</Label>
<Keys>{'`code`'}</Keys>
<Label>Inline code</Label>
</List>
</Flex>
);
}
const List = styled.dl`
width: 100%;
overflow: hidden;
padding: 0;
margin: 0
`;
const Keys = styled.dt`
float: left;
width: 25%;
padding: 0 0 4px;
margin: 0
`;
const Label = styled.dd`
float: left;
width: 75%;
padding: 0 0 4px;
margin: 0
`;
export default KeyboardShortcuts;

2
frontend/static/flatpages/index.js
View File

@@ -1,8 +1,6 @@
// @flow
import api from './api.md';
import keyboard from './keyboard.md';
export default {
api,
keyboard,
};

9
frontend/static/flatpages/keyboard.md
View File

@@ -1,9 +0,0 @@
- `Cmd+Enter` - Save and exit document editor
- `Cmd+s` - Save document and continue editing
- `Cmd+Esc` - Cancel edit
- `/` or `t` - Jump to search
- `d` - Jump to dashboard
- `c` - Compose within a collection
- `e` - Edit document
- `m` - Move document
- `?` - This guide

4
frontend/styles/base.css
View File

@@ -137,3 +137,7 @@ hr {
.activeDropZone a {
color: #FFF !important;
}
.ReactModal__Body--open {
overflow: hidden;
}