improve wording

This commit is contained in:
Philipp Kühn
2018-08-24 23:02:32 +02:00
parent 2e2a07daec
commit 6f8de01405
8 changed files with 22 additions and 19 deletions

View File

@@ -5,7 +5,7 @@
tiptap a renderless rich-text editor toolkit for Vue.js tiptap a renderless rich-text editor toolkit for Vue.js
</h1> </h1>
<p> <p>
This editor is based on <a href="https://prosemirror.net">Prosemirror</a>, <em>fully extendable</em> and renderless. There is a plugin system that lets you render each node as <strong>a vue component</strong>. This editor is based on <a href="https://prosemirror.net">Prosemirror</a>, <em>fully extendable</em> and renderless. You can easily add custom nodes as <strong>Vue components</strong>.
</p> </p>
</div> </div>
</div> </div>

View File

@@ -90,10 +90,10 @@
<div class="editor__content" slot="content" slot-scope="props"> <div class="editor__content" slot="content" slot-scope="props">
<h2> <h2>
Menu Bar Hi there,
</h2> </h2>
<p> <p>
This is a very <em>basic</em> example of tiptap. this is a very <em>basic</em> example of tiptap.
</p> </p>
<pre><code>body { display: none; }</code></pre> <pre><code>body { display: none; }</code></pre>
<ul> <ul>

View File

@@ -7,7 +7,7 @@
Embeds Embeds
</h2> </h2>
<p> <p>
This is an example of a custom iframe node. This iframe is rendered as a vue component. This makes it possible to render some additional markup to change its source. This is an example of a custom iframe node. This iframe is rendered as a <strong>vue component</strong>. This makes it possible to render the input below to change its source.
</p> </p>
<iframe src="https://www.youtube.com/embed/XIMLoLxmTDw" frameborder="0" allowfullscreen></iframe> <iframe src="https://www.youtube.com/embed/XIMLoLxmTDw" frameborder="0" allowfullscreen></iframe>
</div> </div>

View File

@@ -93,7 +93,7 @@
Hiding Menu Bar Hiding Menu Bar
</h2> </h2>
<p> <p>
Try to focus the editor to see the menu. It's like magic. 🔮 Click into this text to see the menu. Click outside and the menu will disappear. It's like magic.
</p> </p>
</div> </div>

View File

@@ -29,7 +29,7 @@
Links Links
</h2> </h2>
<p> <p>
Try to add some links to the <a href="https://en.wikipedia.org/wiki/World_Wide_Web">world wide web</a>. Try to add some links to the <a href="https://en.wikipedia.org/wiki/World_Wide_Web">world wide web</a>. By default every link will get a <code>rel="noopener noreferrer nofollow"</code> attribute.
</p> </p>
</div> </div>
</editor> </editor>

View File

@@ -7,10 +7,10 @@
Markdown Shortcuts Markdown Shortcuts
</h2> </h2>
<p> <p>
Start a new line and type <code>#</code> followed by a space and you will get an H1 headline. 🤯 Start a new line and type <code>#</code> followed by a <code>space</code> and you will get an H1 headline.
</p> </p>
<p> <p>
This feature is called <strong>input rules</strong>. There are some of these shortcuts for the most basic nodes available by default. Try <code>#, ##, ###, </code> for headlines, <code>></code> for blockquotes, <code>- or +</code> for bullet lists. And of course you can add your own input rules. This feature is called <strong>input rules</strong>. There are some of these shortcuts for the most basic nodes enabled by default. Try <code>#, ##, ###, </code> for headlines, <code>></code> for blockquotes, <code>- or +</code> for bullet lists. And of course you can add your own input rules.
</p> </p>
</div> </div>

View File

@@ -37,7 +37,7 @@
Menu Bubble Menu Bubble
</h2> </h2>
<p> <p>
Hey, try to select some text. Hey, try to select some text here. There will popup a menu for selecting some inline styles. <em>Remember:</em> you have full control about content and styling of this menu.
</p> </p>
</div> </div>

View File

@@ -7,26 +7,26 @@
<button <button
class="menubar__button" class="menubar__button"
:class="{ 'is-active': nodes.heading.active({ level: 1 }) }" :class="{ 'is-active': marks.bold.active() }"
@click="nodes.heading.command({ level: 1 })" @click="marks.bold.command"
> >
H1 <icon name="bold" />
</button> </button>
<button <button
class="menubar__button" class="menubar__button"
:class="{ 'is-active': nodes.heading.active({ level: 2 }) }" :class="{ 'is-active': marks.italic.active() }"
@click="nodes.heading.command({ level: 2 })" @click="marks.italic.command"
> >
H2 <icon name="italic" />
</button> </button>
<button <button
class="menubar__button" class="menubar__button"
:class="{ 'is-active': nodes.heading.active({ level: 3 }) }" :class="{ 'is-active': marks.code.active() }"
@click="nodes.heading.command({ level: 3 })" @click="marks.code.command"
> >
H3 <icon name="code" />
</button> </button>
<button <button
@@ -44,6 +44,9 @@
<h2> <h2>
Todo List Todo List
</h2> </h2>
<p>
There is always something to do. Thankfully, there are checklists for that. Don't forget to call mom.
</p>
<ul data-type="todo_list"> <ul data-type="todo_list">
<li data-type="todo_item" data-done="true"> <li data-type="todo_item" data-done="true">
Buy beer Buy beer
@@ -51,7 +54,7 @@
<li data-type="todo_item" data-done="true"> <li data-type="todo_item" data-done="true">
Buy meat Buy meat
</li> </li>
<li data-type="todo_item" data-done="false"> <li data-type="todo_item" data-done="true">
Buy milk Buy milk
</li> </li>
<li data-type="todo_item" data-done="false"> <li data-type="todo_item" data-done="false">