Skip to content

Instantly share code, notes, and snippets.

@koic

koic/document_structure_refactoring.md

Last active March 12, 2017 11:39
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save koic/e26ba095d5ebb5f9e8961acc2b3bf345 to your computer and use it in GitHub Desktop.
Save koic/e26ba095d5ebb5f9e8961acc2b3bf345 to your computer and use it in GitHub Desktop.
Download ZIP
Document Structure Refactoring
Raw
document_structure_refactoring.md

Document Structure Refactoring

Pattern 1: Prefer headings rather than list items.

Prior Structure

Use the list items.

* foo
  * foofoo
* bar
  * barfoo
  * barbar
* baz
  * bazfoo

New Structure

Use the headings.

# Prefer headings rather than list items

The lead sentence.

## foo

foofoo.

## bar

* barfoo
* barbar

## baz

bazfoo.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment