Skip to content

Commit

Permalink
Rewrite accessibility description
Browse files Browse the repository at this point in the history
  • Loading branch information
start committed May 3, 2024
1 parent a9d2da3 commit 7e8955d
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>What’s Up?</title>
<meta name="description" content="Up is a markup language for writing structured documents in plain text. Up supports tables, revealable content (e.g. spoilers), description lists, and more!" />
<script type="text/javascript" src="bundle-4e472129d930acbc8beb.js"></script></head>
<script type="text/javascript" src="bundle-8885d2d8d4d1be6337ed.js"></script></head>

<body>
<div id="documentation-container">
Expand All @@ -26,7 +26,7 @@ <h1 data-up-source-line="1" id="topic-1">What’s Up?</h1><p data-up-source-line
#) Buy happiness</code></pre></dd><dt>Output</dt><dd><ol data-up-source-line="37" reversed start="3"><li value="3"><p data-up-source-line="37">Buy milk</p></li><li value="2"><p data-up-source-line="38">Buy bread</p></li><li><p data-up-source-line="39">Buy happiness</p></li></ol></dd></dl><p data-up-source-line="41">Up usually ignores <a href="#topic-74">Excessive delimiter characters</a>.</p><p data-up-source-line="43">For example, you don’t need to perfectly balance asterisks when stressing or emphasizing text.</p><dl data-up-source-line="45"><dt>Markup</dt><dd><pre data-up-source-line="46"><code>I ***love****** asterisks!</code></pre></dd><dt>Output</dt><dd><p data-up-source-line="51">I <strong><em>love</em></strong> asterisks!</p></dd></dl><p data-up-source-line="53">Up isn’t picky about which brackets you use for <a href="#topic-17">Links</a>.</p><dl data-up-source-line="55"><dt>Markup</dt><dd><pre data-up-source-line="56"><code>- Buy [milk] (en.wikipedia.org/wiki/Milk)
- Buy (bread) [en.wikipedia.org/wiki/Bread]
- Buy [sugar] [en.wikipedia.org/wiki/Sugar]
- Buy (happiness) (en.wikipedia.org/wiki/Happiness)</code></pre></dd><dt>Output</dt><dd><ul data-up-source-line="64"><li><p data-up-source-line="64">Buy <a href="https://en.wikipedia.org/wiki/Milk">milk</a></p></li><li><p data-up-source-line="65">Buy <a href="https://en.wikipedia.org/wiki/Bread">bread</a></p></li><li><p data-up-source-line="66">Buy <a href="https://en.wikipedia.org/wiki/Sugar">sugar</a></p></li><li><p data-up-source-line="67">Buy <a href="https://en.wikipedia.org/wiki/Happiness">happiness</a></p></li></ul></dd></dl><p data-up-source-line="69">Up even supports <a href="#topic-76">Overlapping writing conventions</a>!</p><dl data-up-source-line="71"><dt>Markup</dt><dd><pre data-up-source-line="72"><code>John **enjoys ==sleeping** late== whenever he can.</code></pre></dd><dt>Output</dt><dd><p data-up-source-line="77">John <strong>enjoys <mark>sleeping</mark></strong><mark> late</mark> whenever he can.</p></dd></dl><h3 data-up-source-line="80" id="topic-4">Up uses customizable keywords</h3><p data-up-source-line="83">Too many markup languages devolve into a dense soup of symbols and punctuation.</p><p data-up-source-line="85">When a keyword would provide more clarity than a symbol, Up takes advantage of that! Several writing conventions, including <a href="#topic-58">Tables</a> and <a href="#topic-42">Revealable content</a>, incorporate keywords.</p><p data-up-source-line="87">If you’re a software developer using the Up library, you can provide multiple custom variations for each keyword. To learn more, please see <a href="#topic-98">Customizing keywords</a>.</p><h3 data-up-source-line="90" id="topic-5">Up produces fully accessible HTML</h3><p data-up-source-line="93">From the table of contents to the last movie-ruining spoiler, Up produces fully accessible HTML. This means folks who might struggle to view a screen or a use mouse can enjoy every document.</p><hr data-up-source-line="94"><h2 data-up-source-line="97" id="topic-6">Why <em>not</em> use Up?</h2><h3 data-up-source-line="101" id="topic-7">You want a rich ecosystem of tools</h3><p data-up-source-line="104">There is only one <a href="https://npmjs.com/package/@xcvz/up">software library for Up</a>, written and maintained by only one <a href="https://github.com/start">person</a>. In contrast, <a href="https://duckduckgo.com/?q=markdown">other markup languages</a> have countless tools and plugins.</p><h3 data-up-source-line="107" id="topic-8">You need speed</h3><p data-up-source-line="110">Up is not terribly slow, but it’s not terribly fast, either—at least not yet! If you need instant, real-time parsing and rendering of large documents, Up isn’t the best markup language for you.</p><hr data-up-source-line="111"><h1 data-up-source-line="114" id="topic-9">Writing conventions</h1><p data-up-source-line="118">Don’t get lost! The following terms are occasionally used throughout this section.</p><dl data-up-source-line="120"><dt>Writing convention</dt><dd><p data-up-source-line="121">Any special annotation or formatting recognized by Up.</p></dd><dt>Inline writing convention</dt><dd><p data-up-source-line="124">Any writing convention that can be used within paragraphs. This includes <a href="#topic-12">Emphasis</a> and <a href="#topic-16">Highlighting</a>.</p></dd><dt>Outline writing convention</dt><dd><p data-up-source-line="127">Any non-inline writing convention. This includes <a href="#topic-10">Paragraphs</a> and <a href="#topic-58">Tables</a>.</p></dd></dl><h2 data-up-source-line="130" id="topic-10">Paragraphs</h2><p data-up-source-line="134">Paragraphs are the simplest writing convention in Up.</p><dl data-up-source-line="136"><dt>Markup</dt><dd><pre data-up-source-line="137"><code>Unlike regular dental floss, floss picks are easy to use even if you’re not a trained dental hygienist.
- Buy (happiness) (en.wikipedia.org/wiki/Happiness)</code></pre></dd><dt>Output</dt><dd><ul data-up-source-line="64"><li><p data-up-source-line="64">Buy <a href="https://en.wikipedia.org/wiki/Milk">milk</a></p></li><li><p data-up-source-line="65">Buy <a href="https://en.wikipedia.org/wiki/Bread">bread</a></p></li><li><p data-up-source-line="66">Buy <a href="https://en.wikipedia.org/wiki/Sugar">sugar</a></p></li><li><p data-up-source-line="67">Buy <a href="https://en.wikipedia.org/wiki/Happiness">happiness</a></p></li></ul></dd></dl><p data-up-source-line="69">Up even supports <a href="#topic-76">Overlapping writing conventions</a>!</p><dl data-up-source-line="71"><dt>Markup</dt><dd><pre data-up-source-line="72"><code>John **enjoys ==sleeping** late== whenever he can.</code></pre></dd><dt>Output</dt><dd><p data-up-source-line="77">John <strong>enjoys <mark>sleeping</mark></strong><mark> late</mark> whenever he can.</p></dd></dl><h3 data-up-source-line="80" id="topic-4">Up uses customizable keywords</h3><p data-up-source-line="83">Too many markup languages devolve into a dense soup of symbols and punctuation.</p><p data-up-source-line="85">When a keyword would provide more clarity than a symbol, Up takes advantage of that! Several writing conventions, including <a href="#topic-58">Tables</a> and <a href="#topic-42">Revealable content</a>, incorporate keywords.</p><p data-up-source-line="87">If you’re a software developer using the Up library, you can provide multiple custom variations for each keyword. To learn more, please see <a href="#topic-98">Customizing keywords</a>.</p><h3 data-up-source-line="90" id="topic-5">Up produces fully accessible HTML</h3><p data-up-source-line="93">From the table of contents to the last movie-ruining spoiler, Up always produces fully accessible HTML. That means everyone can enjoy the documents you create, regardless of their physical ability.</p><hr data-up-source-line="94"><h2 data-up-source-line="97" id="topic-6">Why <em>not</em> use Up?</h2><h3 data-up-source-line="101" id="topic-7">You want a rich ecosystem of tools</h3><p data-up-source-line="104">There is only one <a href="https://npmjs.com/package/@xcvz/up">software library for Up</a>, written and maintained by only one <a href="https://github.com/start">person</a>. In contrast, <a href="https://duckduckgo.com/?q=markdown">other markup languages</a> have countless tools and plugins.</p><h3 data-up-source-line="107" id="topic-8">You need speed</h3><p data-up-source-line="110">Up is not terribly slow, but it’s not terribly fast, either—at least not yet! If you need instant, real-time parsing and rendering of large documents, Up isn’t the best markup language for you.</p><hr data-up-source-line="111"><h1 data-up-source-line="114" id="topic-9">Writing conventions</h1><p data-up-source-line="118">Don’t get lost! The following terms are occasionally used throughout this section.</p><dl data-up-source-line="120"><dt>Writing convention</dt><dd><p data-up-source-line="121">Any special annotation or formatting recognized by Up.</p></dd><dt>Inline writing convention</dt><dd><p data-up-source-line="124">Any writing convention that can be used within paragraphs. This includes <a href="#topic-12">Emphasis</a> and <a href="#topic-16">Highlighting</a>.</p></dd><dt>Outline writing convention</dt><dd><p data-up-source-line="127">Any non-inline writing convention. This includes <a href="#topic-10">Paragraphs</a> and <a href="#topic-58">Tables</a>.</p></dd></dl><h2 data-up-source-line="130" id="topic-10">Paragraphs</h2><p data-up-source-line="134">Paragraphs are the simplest writing convention in Up.</p><dl data-up-source-line="136"><dt>Markup</dt><dd><pre data-up-source-line="137"><code>Unlike regular dental floss, floss picks are easy to use even if you’re not a trained dental hygienist.

Floss picks are sold in stylish, resealable plastic bags. Buy some today!</code></pre></dd><dt>Output</dt><dd><p data-up-source-line="144">Unlike regular dental floss, floss picks are easy to use even if you’re not a trained dental hygienist.</p><p data-up-source-line="146">Floss picks are sold in stylish, resealable plastic bags. Buy some today!</p></dd></dl><p data-up-source-line="148">To produce a paragraph, write a line of text. That’s all there is to it!</p><p data-up-source-line="150">Typically, paragraphs are separated by one or two blank lines. Three or more blank lines between paragraphs indicate a meaningful change of subject. To learn more, see <a href="#topic-46">Thematic breaks</a>.</p><p data-up-source-line="152">In contrast, <em>consecutive</em> non-blank lines produce <a href="#topic-11">Line blocks</a>, not consecutive paragraphs.</p><h2 data-up-source-line="155" id="topic-11">Line blocks</h2><p data-up-source-line="159">Use the line block convention for addresses, lyrics, or anything consisting of <em>lines</em> instead of actual <a href="#topic-10">Paragraphs</a>.</p><dl data-up-source-line="161"><dt>Markup</dt><dd><pre data-up-source-line="162"><code>Have you read my new poem?

Expand Down
2 changes: 1 addition & 1 deletion src/content/documentation.up
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ If you’re a software developer using the Up library, you can provide multiple
Up produces fully accessible HTML
=================================

From the table of contents to the last movie-ruining spoiler, Up produces fully accessible HTML. This means folks who might struggle to view a screen or a use mouse can enjoy every document.
From the table of contents to the last movie-ruining spoiler, Up always produces fully accessible HTML. That means everyone can enjoy the documents you create, regardless of their physical ability.



Expand Down

0 comments on commit 7e8955d

Please sign in to comment.