-
Notifications
You must be signed in to change notification settings - Fork 3.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: update docs #2928
docs: update docs #2928
Changes from 6 commits
0829a48
aeba74b
5f65a43
5a120fe
60bb438
d53fad0
8e44df8
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,14 +10,14 @@ | |
- [ ] Run `npm run build:reset` to remove changes to compiled files. | ||
- [ ] Submit a Pull Request. | ||
|
||
## Design principles | ||
<h2 id="design-principles">Design principles</h2> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should we enable header ids instead of doing this manually? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We are already doing it manually in most of our pages so the ids don't get too long. I think we should keep it consistent and we don't want to change it for existing ids otherwise urls will break. |
||
|
||
Marked tends to favor following the SOLID set of software design and development principles; mainly the [single responsibility](https://en.wikipedia.org/wiki/Single_responsibility_principle) and [open/closed principles](https://en.wikipedia.org/wiki/Open/closed_principle): | ||
|
||
- **Single responsibility:** Marked, and the components of Marked, have the single responsibility of converting Markdown strings into HTML. | ||
- **Open/closed:** Marked favors giving developers the means to easily extend the library and its components over changing Marked's behavior through configuration options. | ||
|
||
## Priorities | ||
<h2 id="priorities">Priorities</h2> | ||
|
||
We think we have our priorities sorted to build quality in. | ||
|
||
|
@@ -33,7 +33,7 @@ The following table lists the ticket type labels we use when there is work to be | |
|NFU - new feature (user requested) |A capability Marked does not currently provide but has been requested by users of Marked. | | ||
|NFE - new feature (should be an extension) |A capability Marked does not currently provide and is not part of a spec. | | ||
|
||
## Test early, often, and everything | ||
<h2 id="test-early-often-and-everything">Test early, often, and everything</h2> | ||
|
||
We try to write test cases to validate output (writing tests based on the [supported specifications](/#specifications)) and minimize regression (writing tests for issues fixed). Therefore, if you would like to contribute, some things you should know regarding the test harness. | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,99 +1,125 @@ | ||
/* | ||
|
||
github.com style (c) Vasily Polovnyov <vast@whiteants.net> | ||
/*! | ||
Theme: GitHub | ||
Description: Light theme as seen on github.com | ||
Author: github.com | ||
Maintainer: @Hirse | ||
Updated: 2021-05-15 | ||
|
||
Outdated base version: https://github.com/primer/github-syntax-light | ||
Current colors taken from GitHub's CSS | ||
*/ | ||
|
||
pre { | ||
display: block; | ||
overflow-x: auto; | ||
padding: 0.5em; | ||
color: #333; | ||
background: #f8f8f8; | ||
} | ||
|
||
.hljs-comment, | ||
.hljs-quote { | ||
color: #998; | ||
font-style: italic; | ||
} | ||
|
||
.hljs-keyword, | ||
.hljs-selector-tag, | ||
.hljs-subst { | ||
color: #333; | ||
font-weight: bold; | ||
} | ||
|
||
.hljs-number, | ||
.hljs-literal, | ||
.hljs-variable, | ||
.hljs-template-variable, | ||
.hljs-tag .hljs-attr { | ||
color: #008080; | ||
} | ||
|
||
.hljs-string, | ||
.hljs-doctag { | ||
color: #d14; | ||
} | ||
|
||
.hljs-title, | ||
.hljs-section, | ||
.hljs-selector-id { | ||
color: #900; | ||
font-weight: bold; | ||
} | ||
|
||
.hljs-subst { | ||
font-weight: normal; | ||
} | ||
|
||
.hljs-type, | ||
.hljs-class .hljs-title { | ||
color: #458; | ||
font-weight: bold; | ||
} | ||
|
||
.hljs-tag, | ||
.hljs-name, | ||
.hljs-attribute { | ||
color: #000080; | ||
font-weight: normal; | ||
} | ||
|
||
.hljs-regexp, | ||
.hljs-link { | ||
color: #009926; | ||
} | ||
|
||
.hljs-symbol, | ||
.hljs-bullet { | ||
color: #990073; | ||
} | ||
|
||
.hljs-built_in, | ||
.hljs-builtin-name { | ||
color: #0086b3; | ||
} | ||
|
||
.hljs-meta { | ||
color: #999; | ||
font-weight: bold; | ||
} | ||
|
||
.hljs-deletion { | ||
background: #fdd; | ||
} | ||
|
||
.hljs-addition { | ||
background: #dfd; | ||
} | ||
|
||
.hljs-emphasis { | ||
font-style: italic; | ||
} | ||
|
||
.hljs-strong { | ||
font-weight: bold; | ||
} | ||
.hljs { | ||
color: #24292e; | ||
background: #ffffff; | ||
} | ||
|
||
.hljs-doctag, | ||
.hljs-keyword, | ||
.hljs-meta .hljs-keyword, | ||
.hljs-template-tag, | ||
.hljs-template-variable, | ||
.hljs-type, | ||
.hljs-variable.language_ { | ||
/* prettylights-syntax-keyword */ | ||
color: #d73a49; | ||
} | ||
|
||
.hljs-title, | ||
.hljs-title.class_, | ||
.hljs-title.class_.inherited__, | ||
.hljs-title.function_ { | ||
/* prettylights-syntax-entity */ | ||
color: #6f42c1; | ||
} | ||
|
||
.hljs-attr, | ||
.hljs-attribute, | ||
.hljs-literal, | ||
.hljs-meta, | ||
.hljs-number, | ||
.hljs-operator, | ||
.hljs-variable, | ||
.hljs-selector-attr, | ||
.hljs-selector-class, | ||
.hljs-selector-id { | ||
/* prettylights-syntax-constant */ | ||
color: #005cc5; | ||
} | ||
|
||
.hljs-regexp, | ||
.hljs-string, | ||
.hljs-meta .hljs-string { | ||
/* prettylights-syntax-string */ | ||
color: #032f62; | ||
} | ||
|
||
.hljs-built_in, | ||
.hljs-symbol { | ||
/* prettylights-syntax-variable */ | ||
color: #e36209; | ||
} | ||
|
||
.hljs-comment, | ||
.hljs-code, | ||
.hljs-formula { | ||
/* prettylights-syntax-comment */ | ||
color: #6a737d; | ||
} | ||
|
||
.hljs-name, | ||
.hljs-quote, | ||
.hljs-selector-tag, | ||
.hljs-selector-pseudo { | ||
/* prettylights-syntax-entity-tag */ | ||
color: #22863a; | ||
} | ||
|
||
.hljs-subst { | ||
/* prettylights-syntax-storage-modifier-import */ | ||
color: #24292e; | ||
} | ||
|
||
.hljs-section { | ||
/* prettylights-syntax-markup-heading */ | ||
color: #005cc5; | ||
font-weight: bold; | ||
} | ||
|
||
.hljs-bullet { | ||
/* prettylights-syntax-markup-list */ | ||
color: #735c0f; | ||
} | ||
|
||
.hljs-emphasis { | ||
/* prettylights-syntax-markup-italic */ | ||
color: #24292e; | ||
font-style: italic; | ||
} | ||
|
||
.hljs-strong { | ||
/* prettylights-syntax-markup-bold */ | ||
color: #24292e; | ||
font-weight: bold; | ||
} | ||
|
||
.hljs-addition { | ||
/* prettylights-syntax-markup-inserted */ | ||
color: #22863a; | ||
background-color: #f0fff4; | ||
} | ||
|
||
.hljs-deletion { | ||
/* prettylights-syntax-markup-deleted */ | ||
color: #b31d28; | ||
background-color: #ffeef0; | ||
} | ||
|
||
.hljs-char.escape_, | ||
.hljs-link, | ||
.hljs-params, | ||
.hljs-property, | ||
.hljs-punctuation, | ||
.hljs-tag { | ||
/* purposely ignored */ | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should add
utf8
here to work with the string instead of the buffer..That can be a future PR 😄