Merge pull request #1 from codex-editor/initial

Inline Code Tool

Author: talyguryn

.gitattributes

@@ -0,0 +1,4 @@
+node_modules/*
+npm-debug.log
+.idea/
+.DS_Store

.gitignore

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 CodeX
+
+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.

LICENSE

@@ -0,0 +1,80 @@
+![](https://badgen.net/badge/CodeX%20Editor/v2.0/blue)
+
+# InlineCode Tool
+
+Inline Tool for marking code-fragments for the [CodeX Editor](https://ifmo.su/editor).
+
+![](assets/example.gif)
+
+## Installation
+
+### Install via NPM
+
+Get the package
+
+```shell
+npm i --save-dev codex.editor.inline-code
+```
+
+Include module at your application
+
+```javascript
+const InlineCode = require('codex.editor.inline-code');
+```
+
+### Download to your project's source dir
+
+1. Upload folder `dist` from repository
+2. Add `dist/bundle.js` file to your page.
+
+### Load from CDN
+
+Get newest bundle path from [RawGit](https://rawgit.com) — open site and paste link to JS bundle in repository.
+
+`https://github.com/codex-editor/inline-code/blob/master/dist/bundle.js`
+
+> Note: use `production` link with commit hash to avoid issues with caching.
+
+Then require this script on page with CodeX Editor.
+
+```html
+<script src="..."></script>
+```
+
+## Usage
+
+Add a new Tool to the `tools` property of the CodeX Editor initial config.
+
+```javascript
+var editor = CodexEditor({
+  ...
+  
+  tools: {
+    ...
+    inlineCode: {
+      class: InlineCode,
+      shortcut: 'CMD+SHIFT+M',
+    },
+  },
+  
+  ...
+});
+```
+
+## Config Params
+
+This Tool has no config params
+
+## Output data
+
+Marked text will be wrapped with a `span` tag with an `inline-code` class.
+
+```json
+{
+    "type" : "text",
+    "data" : {
+        "text" : "Create a directory for your module, enter it and run <span class=\"inline-code\">npm init</span> command."
+    }
+}
+```
+