Skip to content

Commit

Permalink
docs ~ (README) stabilize formatting against changes by deno and/or d…
Browse files Browse the repository at this point in the history
…print formatters

# [why]

This construction of comments will maintain a stable, Prettier-type formatting even if a
reformat of the file is attempted with `deno fmt` or `dprint fmt`.

Notably, comments prior to `<!DOCTYPE...>` are legal in the standard, but may throw the
MS IE browser into "quirks mode". However, when using modern (2020+) markdown renderers,
this *should not* cause any changes to final rendered output.

ref: [Can comments appear before the DOCTYPE declaration?](https://stackoverflow.com/questions/941100/can-comments-appear-before-the-doctype-declaration)
  • Loading branch information
rivy committed Aug 1, 2022
1 parent 4884af6 commit d87a6f0
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
<!DOCTYPE markdown><!-- markdownlint-disable first-line-heading no-inline-html --><!-- @prettier --><!-- deno-fmt-ignore-file --><!-- dprint-fmt-ignore-file -->
<!-- dprint-ignore-file -->
<!-- deno-fmt-ignore-start -->

<!-- @prettier -->
<!DOCTYPE markdown><!-- markdownlint-disable first-line-heading no-inline-html -->
<meta charset="utf-8" content="text/markdown" lang="en">
<!-- -## editors ## (emacs/sublime) -*- coding: utf8-nix; tab-width: 4; mode: markdown; indent-tabs-mode: nil; basic-offset: 2; st-word_wrap: 'true' -*- ## (jEdit) :tabSize=4:indentSize=4:mode=markdown: ## (notepad++) vim:tabstop=4:syntax=markdown:expandtab:smarttab:softtabstop=2 ## modeline (see <https://archive.is/djTUD>@@<http://webcitation.org/66W3EhCAP> ) -->
<!-- spell-checker:ignore expandtab markdownlint modeline smarttab softtabstop -->
Expand Down

0 comments on commit d87a6f0

Please sign in to comment.