Skip to content

Commit

Permalink
docs(rename): renaming bustlelabs -> bustle with the exception of git…
Browse files Browse the repository at this point in the history
…ter.im links (#560)
  • Loading branch information
rhwlo authored and bantic committed May 22, 2017
1 parent 2cfb245 commit cf2eee6
Show file tree
Hide file tree
Showing 40 changed files with 929 additions and 929 deletions.
10 changes: 5 additions & 5 deletions CARDS.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Mobiledoc Cards

Cards are an API supported by
[Mobiledoc Kit](https://github.com/bustlelabs/mobiledoc-kit),
the [Mobiledoc format](https://github.com/bustlelabs/mobiledoc-kit/blob/master/MOBILEDOC.md),
the [Mobiledoc DOM Renderer](https://github.com/bustlelabs/mobiledoc-dom-renderer),
the [Mobiledoc HTML Renderer](https://github.com/bustlelabs/mobiledoc-html-renderer),
and the [Mobiledoc Text Renderer](https://github.com/bustlelabs/mobiledoc-text-renderer).
[Mobiledoc Kit](https://github.com/bustle/mobiledoc-kit),
the [Mobiledoc format](https://github.com/bustle/mobiledoc-kit/blob/master/MOBILEDOC.md),
the [Mobiledoc DOM Renderer](https://github.com/bustle/mobiledoc-dom-renderer),
the [Mobiledoc HTML Renderer](https://github.com/bustle/mobiledoc-html-renderer),
and the [Mobiledoc Text Renderer](https://github.com/bustle/mobiledoc-text-renderer).


## Card format
Expand Down
1,532 changes: 766 additions & 766 deletions CHANGELOG.md

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions MOBILEDOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ prescription for output display.

Often Mobiledoc will be used with one or more of:

* [Mobiledoc Kit](https://github.com/bustlelabs/mobiledoc-kit) to author an editor
* [Ember Mobiledoc Editor](https://github.com/bustlelabs/ember-mobiledoc-editor) is one such editor
* [Mobiledoc DOM Renderer](https://github.com/bustlelabs/mobiledoc-dom-renderer)
* [Mobiledoc HTML Renderer](https://github.com/bustlelabs/mobiledoc-html-renderer)
* [Mobiledoc Text Renderer](https://github.com/bustlelabs/mobiledoc-text-renderer)
* [Mobiledoc Kit](https://github.com/bustle/mobiledoc-kit) to author an editor
* [Ember Mobiledoc Editor](https://github.com/bustle/ember-mobiledoc-editor) is one such editor
* [Mobiledoc DOM Renderer](https://github.com/bustle/mobiledoc-dom-renderer)
* [Mobiledoc HTML Renderer](https://github.com/bustle/mobiledoc-html-renderer)
* [Mobiledoc Text Renderer](https://github.com/bustle/mobiledoc-text-renderer)

## Specification

Expand Down
44 changes: 22 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

[![Sauce Test Status](https://saucelabs.com/browser-matrix/mobiledoc-kit.svg)](https://saucelabs.com/u/mobiledoc-kit)

[![Dependency Status](https://david-dm.org/bustlelabs/mobiledoc-kit/master.svg)](https://david-dm.org/bustlelabs/mobiledoc-kit/master)
[![devDependency Status](https://david-dm.org/bustlelabs/mobiledoc-kit/master/dev-status.svg)](https://david-dm.org/bustlelabs/mobiledoc-kit/master#info=devDependencies)
[![Dependency Status](https://david-dm.org/bustle/mobiledoc-kit/master.svg)](https://david-dm.org/bustle/mobiledoc-kit/master)
[![devDependency Status](https://david-dm.org/bustle/mobiledoc-kit/master/dev-status.svg)](https://david-dm.org/bustle/mobiledoc-kit/master#info=devDependencies)

![Mobiledoc Logo](https://bustlelabs.github.io/mobiledoc-kit/demo/mobiledoc-logo-color-small.png)
![Mobiledoc Logo](https://bustle.github.io/mobiledoc-kit/demo/mobiledoc-logo-color-small.png)

Mobiledoc Kit (warning: beta) is a library for building WYSIWYG editors
supporting rich content via cards.
Expand All @@ -16,29 +16,29 @@ This repository hosts the core Mobiledoc-Kit library. If you want to use Mobiled

| Environment | Library |
| ----------- | ------- |
| Plain JavaScript | [mobiledoc-kit](https://github.com/bustlelabs/mobiledoc-kit) (this repo) |
| Ember | [ember-mobiledoc-editor](https://github.com/bustlelabs/ember-mobiledoc-editor) |
| Plain JavaScript | [mobiledoc-kit](https://github.com/bustle/mobiledoc-kit) (this repo) |
| Ember | [ember-mobiledoc-editor](https://github.com/bustle/ember-mobiledoc-editor) |
| React | [react-mobiledoc-editor](https://github.com/upworthy/react-mobiledoc-editor) |
| Vue | [vue-mobiledoc-editor](https://github.com/alidcastano/vue-mobiledoc-editor) |

If you only want to use the Mobiledoc-Kit runtime, for *rendering mobiledoc posts only* (not editing or creating them), you can use:

| Output Format/Environment | Library |
| ---------- | ------- |
| Plain JavaScript In-Browser (DOM) | [mobiledoc-dom-renderer](https://github.com/bustlelabs/mobiledoc-dom-renderer) |
| Server-Side Rendering (HTML) | see [mobiledoc-dom-renderer's Rendering HTML section](https://github.com/bustlelabs/mobiledoc-dom-renderer#rendering-html) |
| Server-Side Rendering (Text-only, e.g. SEO) | [mobiledoc-text-renderer](https://github.com/bustlelabs/mobiledoc-text-renderer) |
| In-Browser (DOM) Rendering, with Ember | [ember-mobiledoc-dom-renderer](https://github.com/bustlelabs/ember-mobiledoc-dom-renderer) |
| Plain JavaScript In-Browser (DOM) | [mobiledoc-dom-renderer](https://github.com/bustle/mobiledoc-dom-renderer) |
| Server-Side Rendering (HTML) | see [mobiledoc-dom-renderer's Rendering HTML section](https://github.com/bustle/mobiledoc-dom-renderer#rendering-html) |
| Server-Side Rendering (Text-only, e.g. SEO) | [mobiledoc-text-renderer](https://github.com/bustle/mobiledoc-text-renderer) |
| In-Browser (DOM) Rendering, with Ember | [ember-mobiledoc-dom-renderer](https://github.com/bustle/ember-mobiledoc-dom-renderer) |

Mobiledoc is a deliberately simple and terse format, and you are encouraged to write your own renderer if you have other target output formats (e.g., a PDF renderer, an iOS Native Views Renderer, etc.).

## Demo

Try a demo at [bustlelabs.github.io/mobiledoc-kit/demo](https://bustlelabs.github.io/mobiledoc-kit/demo/).
Try a demo at [bustle.github.io/mobiledoc-kit/demo](https://bustle.github.io/mobiledoc-kit/demo/).

## API Documentation

API Documentation is [available online](http://bustlelabs.github.io/mobiledoc-kit/demo/docs/).
API Documentation is [available online](http://bustle.github.io/mobiledoc-kit/demo/docs/).

## Intro to Mobiledoc Kit

Expand All @@ -51,10 +51,10 @@ API Documentation is [available online](http://bustlelabs.github.io/mobiledoc-ki
article "cards" and rich inline elements "atoms" and implementing a new one doesn't require an understanding
of Mobiledoc editor internals. Adding a new atom or card takes an afternoon, not several
days. To learn more, see the docs for
**[Atoms](https://github.com/bustlelabs/mobiledoc-kit/blob/master/ATOMS.md)**,
**[Cards](https://github.com/bustlelabs/mobiledoc-kit/blob/master/CARDS.md)**
**[Atoms](https://github.com/bustle/mobiledoc-kit/blob/master/ATOMS.md)**,
**[Cards](https://github.com/bustle/mobiledoc-kit/blob/master/CARDS.md)**
and
**[Mobiledoc Renderers](https://github.com/bustlelabs/mobiledoc-kit/blob/master/RENDERERS.md)**
**[Mobiledoc Renderers](https://github.com/bustle/mobiledoc-kit/blob/master/RENDERERS.md)**

To learn more about the ideas behind Mobiledoc and the editor (note that the
editor used to be named Content-Kit), see these blog posts:
Expand All @@ -64,7 +64,7 @@ editor used to be named Content-Kit), see these blog posts:
* [Content-Kit: Programmatic Editing](http://madhatted.com/2015/8/25/content-kit-programmatic-editing)

The Mobiledoc kit saves posts in
**[Mobiledoc format](https://github.com/bustlelabs/mobiledoc-kit/blob/master/MOBILEDOC.md)**.
**[Mobiledoc format](https://github.com/bustle/mobiledoc-kit/blob/master/MOBILEDOC.md)**.

### Usage

Expand Down Expand Up @@ -104,7 +104,7 @@ editor.render(element);
whenever it encounters an unknown card
* `unknownAtomHandler` - [function] This will be invoked by the editor-renderer
whenever it encounters an unknown atom
* `parserPlugins` - [array] See [DOM Parsing Hooks](https://github.com/bustlelabs/mobiledoc-kit#dom-parsing-hooks)
* `parserPlugins` - [array] See [DOM Parsing Hooks](https://github.com/bustle/mobiledoc-kit#dom-parsing-hooks)

The editor leverages unicode characters, so HTML documents must opt in to
UTF8. For example this can be done by adding the following to an HTML
Expand Down Expand Up @@ -218,7 +218,7 @@ The available lifecycle hooks are:
* `editor.didDelete((range, direction, unit))` - Provides `range`, `direction` and `unit` to identify the completed deletion.
* `editor.cursorDidChange()` - When the cursor (or selection) changes as a result of arrow-key
movement or clicking in the document.
* `editor.onTextInput()` - When the user adds text to the document (see [example](https://github.com/bustlelabs/mobiledoc-kit#responding-to-text-input))
* `editor.onTextInput()` - When the user adds text to the document (see [example](https://github.com/bustle/mobiledoc-kit#responding-to-text-input))

### Programmatic Post Editing

Expand Down Expand Up @@ -249,10 +249,10 @@ editor.run(postEditor => {
});
```

For more details on the API of `postEditor`, see the [API documentation](https://github.com/bustlelabs/mobiledoc-kit/blob/master/src/js/editor/post.js).
For more details on the API of `postEditor`, see the [API documentation](https://github.com/bustle/mobiledoc-kit/blob/master/src/js/editor/post.js).

For more details on the API for the builder, required to create new sections
atoms, and markers, see the [builder API](https://github.com/bustlelabs/mobiledoc-kit/blob/master/src/js/models/post-node-builder.js).
atoms, and markers, see the [builder API](https://github.com/bustle/mobiledoc-kit/blob/master/src/js/models/post-node-builder.js).

### Configuring hot keys

Expand Down Expand Up @@ -374,7 +374,7 @@ parsed by the next plugin or the default parser.
## Caveats

### Mobiledoc-kit and the Grammarly extension
`mobiledoc-kit` and the [Grammarly extension](https://www.grammarly.com/) do not play well together (see [issue 422](https://github.com/bustlelabs/mobiledoc-kit/issues/422)). Until this is resolved, you can avoid any such problems by disabling Grammarly for the `mobiledoc-kit` instances on your page. To do this, add the `data-gramm="false"` attribute to the `mobiledoc-kit` main DOM element.
`mobiledoc-kit` and the [Grammarly extension](https://www.grammarly.com/) do not play well together (see [issue 422](https://github.com/bustle/mobiledoc-kit/issues/422)). Until this is resolved, you can avoid any such problems by disabling Grammarly for the `mobiledoc-kit` instances on your page. To do this, add the `data-gramm="false"` attribute to the `mobiledoc-kit` main DOM element.

## Contributing

Expand Down Expand Up @@ -410,7 +410,7 @@ The assets for the demo are in `assets/demo`.

### Getting Help

If you notice a bug or have a feature request please [open an issue on github](https://github.com/bustlelabs/mobiledoc-kit/issues).
If you notice a bug or have a feature request please [open an issue on github](https://github.com/bustle/mobiledoc-kit/issues).
If you have a question about usage you can post in the [slack channel](https://mobiledoc-kit.slack.com/) (automatic invites available from our [slackin app](https://mobiledoc-slack.herokuapp.com/)) or on StackOverflow using the [`mobiledoc-kit` tag](http://stackoverflow.com/questions/tagged/mobiledoc-kit).

### Releasing (Implementer notes)
Expand All @@ -427,6 +427,6 @@ The demo website is hosted at github pages. To publish a new version:
* `npm run deploy:website` - Pushes the `website/` subtree to the `gh-pages`
branch of your `origin` at github

Visit [bustlelabs.github.io/mobiledoc-kit/demo](https://bustlelabs.github.io/mobiledoc-kit/demo).
Visit [bustle.github.io/mobiledoc-kit/demo](https://bustle.github.io/mobiledoc-kit/demo).

*Development of Mobiledoc and the supporting libraries was generously funded by [Bustle Labs](http://www.bustle.com/labs). Bustle Labs is the tech team behind the editorial staff at [Bustle](http://www.bustle.com), a fantastic and successful feminist and women’s interest site based in NYC.*
30 changes: 15 additions & 15 deletions assets/demo/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@
<script>hljs.initHighlightingOnLoad();</script>
</body>

<a href="https://github.com/bustlelabs/mobiledoc-kit"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://camo.githubusercontent.com/a6677b08c955af8400f44c6298f40e7d19cc5b2d/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f677261795f3664366436642e706e67" alt="Fork me on GitHub" data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png"></a>
<a href="https://github.com/bustle/mobiledoc-kit"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://camo.githubusercontent.com/a6677b08c955af8400f44c6298f40e7d19cc5b2d/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f677261795f3664366436642e706e67" alt="Fork me on GitHub" data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png"></a>

<header>
<a href='https://github.com/bustlelabs/mobiledoc-kit'>
<a href='https://github.com/bustle/mobiledoc-kit'>
<img id='logo' alt="Mobiledoc Kit Logo" src="mobiledoc-logo-color-small.png">
</a>
</header>
Expand All @@ -30,15 +30,15 @@
</p>

<p>
Publishers use the <a href='https://github.com/bustlelabs/mobiledoc-kit'>Mobiledoc-Kit</a> library to
Publishers use the <a href='https://github.com/bustle/mobiledoc-kit'>Mobiledoc-Kit</a> library to
build rich-content editors customized for their content. Posts are serialized to the
JSON-based <a href='https://github.com/bustlelabs/mobiledoc-kit/blob/master/MOBILEDOC.md'>Mobiledoc format</a>, a
JSON-based <a href='https://github.com/bustle/mobiledoc-kit/blob/master/MOBILEDOC.md'>Mobiledoc format</a>, a
structure designed to unambiguously represent the content and be simple to render
in a variety of display contexts such as server-side HTML, in-browser DOM, and SEO-friendly text.
</p>

<p>
Mobiledoc supports rich, interactive content via <a href='https://github.com/bustlelabs/mobiledoc-kit/blob/master/CARDS.md'>cards</a> and <a href='https://github.com/bustlelabs/mobiledoc-kit/blob/master/ATOMS.md'>atoms</a>.
Mobiledoc supports rich, interactive content via <a href='https://github.com/bustle/mobiledoc-kit/blob/master/CARDS.md'>cards</a> and <a href='https://github.com/bustle/mobiledoc-kit/blob/master/ATOMS.md'>atoms</a>.
</p>

<p>
Expand Down Expand Up @@ -69,7 +69,7 @@
<div class="column right tall">
<div class="info">
<p>
And see its representation in <a href='https://github.com/bustlelabs/mobiledoc-kit/blob/master/MOBILEDOC.md'>Mobiledoc format</a> here:
And see its representation in <a href='https://github.com/bustle/mobiledoc-kit/blob/master/MOBILEDOC.md'>Mobiledoc format</a> here:
</p>
</div>
<div id='editor-output' class='mobiledoc-output'></div>
Expand All @@ -95,11 +95,11 @@ <h3>Create Mobiledoc Editor</h3>
</tr>
<tr>
<td>JavaScript</td>
<td><a href='https://github.com/bustlelabs/mobiledoc-kit'>mobiledoc-kit</a></td>
<td><a href='https://github.com/bustle/mobiledoc-kit'>mobiledoc-kit</a></td>
</tr>
<tr>
<td>Ember.js</td>
<td><a href='https://github.com/bustlelabs/ember-mobiledoc-editor'>ember-mobiledoc-editor</a></td>
<td><a href='https://github.com/bustle/ember-mobiledoc-editor'>ember-mobiledoc-editor</a></td>
</tr>
<tr>
<td>React</td>
Expand All @@ -116,19 +116,19 @@ <h3>Render Mobiledoc</h3>
</tr>
<tr>
<td>JavaScript in-browser (DOM)</td>
<td><a href='https://github.com/bustlelabs/mobiledoc-dom-renderer'>mobiledoc-dom-renderer</a></td>
<td><a href='https://github.com/bustle/mobiledoc-dom-renderer'>mobiledoc-dom-renderer</a></td>
</tr>
<tr>
<td>Server-side (HTML)</td>
<td>See mobiledoc-dom-renderer's <a href='https://github.com/bustlelabs/mobiledoc-dom-renderer#rendering-html'>Rendering HTML</a> section</td>
<td>See mobiledoc-dom-renderer's <a href='https://github.com/bustle/mobiledoc-dom-renderer#rendering-html'>Rendering HTML</a> section</td>
</tr>
<tr>
<td>Server-side (text)</td>
<td><a href='https://github.com/bustlelabs/mobiledoc-text-renderer'>mobiledoc-text-renderer</a></td>
<td><a href='https://github.com/bustle/mobiledoc-text-renderer'>mobiledoc-text-renderer</a></td>
</tr>
<tr>
<td>In-browser (DOM) with Ember.js</td>
<td><a href='https://github.com/bustlelabs/ember-mobiledoc-dom-renderer'>ember-mobiledoc-dom-renderer</a></td>
<td><a href='https://github.com/bustle/ember-mobiledoc-dom-renderer'>ember-mobiledoc-dom-renderer</a></td>
</tr>
<tr>
<td>In-browser (DOM) with React</td>
Expand All @@ -147,7 +147,7 @@ <h2>Examples</h2>
<h3>Basic Editor</h3>

<p>
To create an editor, make a new instance of <a href='http://bustlelabs.github.io/mobiledoc-kit/demo/docs/Editor.html'><code>Mobiledoc.Editor</code></a> and render it
To create an editor, make a new instance of <a href='http://bustle.github.io/mobiledoc-kit/demo/docs/Editor.html'><code>Mobiledoc.Editor</code></a> and render it
to an element.
</p>

Expand All @@ -173,7 +173,7 @@ <h3>Basic Editor</h3>
<h3>Toolbar Buttons</h3>

<p>
Use the <a href='http://bustlelabs.github.io/mobiledoc-kit/demo/docs/Editor.html#toggleMarkup'><code>editor.toggleMarkup</code></a> and <a href='http://bustlelabs.github.io/mobiledoc-kit/demo/docs/Editor.html#toggleSection'><code>editor.toggleSelection</code></a> methods to modify
Use the <a href='http://bustle.github.io/mobiledoc-kit/demo/docs/Editor.html#toggleMarkup'><code>editor.toggleMarkup</code></a> and <a href='http://bustle.github.io/mobiledoc-kit/demo/docs/Editor.html#toggleSection'><code>editor.toggleSelection</code></a> methods to modify
the text.
</p>

Expand Down Expand Up @@ -212,7 +212,7 @@ <h2>Cards and Atoms</h2>
</p>

<p>
Cards and atoms can be inserted using the <a href='http://bustlelabs.github.io/mobiledoc-kit/demo/docs/Editor.html#insertCard'><code>editor.insertCard</code></a> and <a href='http://bustlelabs.github.io/mobiledoc-kit/demo/docs/Editor.html#insertAtom'><code>editor.insertAtom</code></a> APIs.
Cards and atoms can be inserted using the <a href='http://bustle.github.io/mobiledoc-kit/demo/docs/Editor.html#insertCard'><code>editor.insertCard</code></a> and <a href='http://bustle.github.io/mobiledoc-kit/demo/docs/Editor.html#insertAtom'><code>editor.insertAtom</code></a> APIs.
</p>

<div class='two-column'>
Expand Down
2 changes: 1 addition & 1 deletion bin/deploy-website.sh
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/bash

git push origin `git subtree split --prefix website`:gh-pages --force
echo "Deployed to http://bustlelabs.github.io/mobiledoc-kit/demo/"
echo "Deployed to http://bustle.github.io/mobiledoc-kit/demo/"
2 changes: 1 addition & 1 deletion bower.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "mobiledoc-kit",
"version": "0.0.0",
"homepage": "https://github.com/bustlelabs/mobiledoc-kit",
"homepage": "https://github.com/bustle/mobiledoc-kit",
"moduleType": [
"amd",
"es6",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "mobiledoc-kit",
"version": "0.10.15",
"description": "A toolkit for building WYSIWYG editors with Mobiledoc",
"repository": "https://github.com/bustlelabs/mobiledoc-kit",
"repository": "https://github.com/bustle/mobiledoc-kit",
"scripts": {
"start": "broccoli serve --host 0.0.0.0",
"test:ci": "PATH=node_modules/phantomjs-prebuilt/bin/:$PATH npm run build:docs && npm run build && testem ci -f testem-ci.json",
Expand Down
2 changes: 1 addition & 1 deletion src/js/editor/editor.js
Original file line number Diff line number Diff line change
Expand Up @@ -1044,7 +1044,7 @@ class Editor {
// the selection but lose focus, and the next keystroke by the user
// will cause an unexpected DOM mutation (which can wipe out the
// card).
// See: https://github.com/bustlelabs/mobiledoc-kit/issues/286
// See: https://github.com/bustle/mobiledoc-kit/issues/286
postEditor.setRange(card.tailPosition());
});
return card;
Expand Down
2 changes: 1 addition & 1 deletion src/js/editor/post.js
Original file line number Diff line number Diff line change
Expand Up @@ -690,7 +690,7 @@ class PostEditor {
// and re-opening of surrounding tags.
// So, we look for any tags open across the whole range, and push into the stack
// at the end of those.
// Prompted by https://github.com/bustlelabs/mobiledoc-kit/issues/360
// Prompted by https://github.com/bustle/mobiledoc-kit/issues/360

let markupsOpenAcrossRange = reduce(markers, function (soFar, marker) {
return commonItems(soFar, marker.markups);
Expand Down
Loading

0 comments on commit cf2eee6

Please sign in to comment.