Skip to content

Commit

Permalink
Tighten up lists; slightly improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
start committed May 2, 2024
1 parent 126e9ac commit c58beb5
Show file tree
Hide file tree
Showing 7 changed files with 117 additions and 107 deletions.

Large diffs are not rendered by default.

182 changes: 91 additions & 91 deletions docs/index.html

Large diffs are not rendered by default.

24 changes: 15 additions & 9 deletions src/content/documentation.up
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@
What’s Up?
##########

Up is a markup language for writing structured documents in plain text.
Up is a markup language for writing structured documents in plain text! Up supports:

- Super easy [topic: tables]
- [Topic: revealable content] (e.g. spoilers)
- [Topic: description lists]
- [Topic: overlapping]
- So much more!

For software developers, Up offers a software library that converts Up markup into HTML. To learn more, please see [topic: using the Up library].

Expand Down Expand Up @@ -1048,39 +1054,39 @@ If your list item contains more than one line, subsequent lines should be indent

Markup
````
- Buy milk.
- Buy milk!

If whole milk is on sale, buy that. Otherwise, buy 2%.

- Buy bread.
- Buy bread!

Only buy bread from one of the following brands:

* Little Northern Bakehouse
* Udi’s
* Canyon Bakehouse

- Buy happiness.
- Buy happiness!

Don’t spend more than a few cents on this.
It’s usually near the self-checkout area.
````

Output
- Buy milk.
- Buy milk!

If whole milk is on sale, buy that. Otherwise, buy 2%.

- Buy bread.
- Buy bread!

Only buy bread from one of the following brands:

* Little Northern Bakehouse
* Udi’s
* Canyon Bakehouse

- Buy happiness.
- Buy happiness!

Don’t spend more than a few cents on this.
It’s usually near the self-checkout area.


==============
Expand Down
3 changes: 1 addition & 2 deletions src/style/documentation-container.scss
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@
@import 'writing-conventions/inline-quote.scss';
@import 'writing-conventions/line-block.scss';
@import 'writing-conventions/link.scss';
@import 'writing-conventions/unordered-list.scss';
@import 'writing-conventions/ordered-list.scss';
@import 'writing-conventions/ordered-and-unordered-lists';
@import 'writing-conventions/parenthetical.scss';
@import 'writing-conventions/revealable.scss';
@import 'writing-conventions/table.scss';
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
// Without some extra margin, consecutive lists appear merged together.
ol + ol,
ul + ul { margin-top: 40px }

// Most list items contain just a single line (technically a paragraph).
//
// Unless we shrink the margins of that single inner paragraph, those
// list items appear a little too spaced out.
li p:only-child { margin: .5em 0 }
2 changes: 0 additions & 2 deletions src/style/writing-conventions/ordered-list.scss

This file was deleted.

2 changes: 0 additions & 2 deletions src/style/writing-conventions/unordered-list.scss

This file was deleted.

0 comments on commit c58beb5

Please sign in to comment.