mirror of
https://github.com/goldbergyoni/nodebestpractices.git
synced 2025-10-30 09:05:43 +08:00
Update readme-copy.md
This commit is contained in:
132
readme-copy.md
132
readme-copy.md
@ -55,135 +55,3 @@ This repository summarizes and curates most of the knowledge gathered to date on
|
|||||||
|
|
||||||
# Security Practices
|
# Security Practices
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Item | Value | Qty |
|
|
||||||
| :------- | ----: | :---: |
|
|
||||||
| Computer | $1600 | 5 |
|
|
||||||
| Phone | $12 | 12 |
|
|
||||||
| Pipe | $1 | 234 |
|
|
||||||
|
|
||||||
|
|
||||||
### Definition Lists
|
|
||||||
|
|
||||||
**Markdown Extra** has a special syntax for definition lists too:
|
|
||||||
|
|
||||||
Term 1
|
|
||||||
Term 2
|
|
||||||
: Definition A
|
|
||||||
: Definition B
|
|
||||||
|
|
||||||
Term 3
|
|
||||||
|
|
||||||
: Definition C
|
|
||||||
|
|
||||||
: Definition D
|
|
||||||
|
|
||||||
> part of definition D
|
|
||||||
|
|
||||||
|
|
||||||
### Fenced code blocks
|
|
||||||
|
|
||||||
GitHub's fenced code blocks are also supported with **Highlight.js** syntax highlighting:
|
|
||||||
|
|
||||||
```
|
|
||||||
// Foo
|
|
||||||
var bar = 0;
|
|
||||||
```
|
|
||||||
|
|
||||||
> **Tip:** To use **Prettify** instead of **Highlight.js**, just configure the **Markdown Extra** extension in the <i class="icon-cog"></i> **Settings** dialog.
|
|
||||||
|
|
||||||
> **Note:** You can find more information:
|
|
||||||
|
|
||||||
> - about **Prettify** syntax highlighting [here][5],
|
|
||||||
> - about **Highlight.js** syntax highlighting [here][6].
|
|
||||||
|
|
||||||
|
|
||||||
### Footnotes
|
|
||||||
|
|
||||||
You can create footnotes like this[^footnote].
|
|
||||||
|
|
||||||
[^footnote]: Here is the *text* of the **footnote**.
|
|
||||||
|
|
||||||
|
|
||||||
### SmartyPants
|
|
||||||
|
|
||||||
SmartyPants converts ASCII punctuation characters into "smart" typographic punctuation HTML entities. For example:
|
|
||||||
|
|
||||||
| | ASCII | HTML |
|
|
||||||
----------------- | ---------------------------- | ------------------
|
|
||||||
| Single backticks | `'Isn't this fun?'` | 'Isn't this fun?' |
|
|
||||||
| Quotes | `"Isn't this fun?"` | "Isn't this fun?" |
|
|
||||||
| Dashes | `-- is en-dash, --- is em-dash` | -- is en-dash, --- is em-dash |
|
|
||||||
|
|
||||||
|
|
||||||
### Table of contents
|
|
||||||
|
|
||||||
You can insert a table of contents using the marker `[TOC]`:
|
|
||||||
|
|
||||||
[TOC]
|
|
||||||
|
|
||||||
|
|
||||||
### MathJax
|
|
||||||
|
|
||||||
You can render *LaTeX* mathematical expressions using **MathJax**, as on [math.stackexchange.com][1]:
|
|
||||||
|
|
||||||
The *Gamma function* satisfying $\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$ is via the Euler integral
|
|
||||||
|
|
||||||
$$
|
|
||||||
\Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,.
|
|
||||||
$$
|
|
||||||
|
|
||||||
> **Tip:** To make sure mathematical expressions are rendered properly on your website, include **MathJax** into your template:
|
|
||||||
|
|
||||||
```
|
|
||||||
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML"></script>
|
|
||||||
```
|
|
||||||
|
|
||||||
> **Note:** You can find more information about **LaTeX** mathematical expressions [here][4].
|
|
||||||
|
|
||||||
|
|
||||||
### UML diagrams
|
|
||||||
|
|
||||||
You can also render sequence diagrams like this:
|
|
||||||
|
|
||||||
```sequence
|
|
||||||
Alice->Bob: Hello Bob, how are you?
|
|
||||||
Note right of Bob: Bob thinks
|
|
||||||
Bob-->Alice: I am good thanks!
|
|
||||||
```
|
|
||||||
|
|
||||||
And flow charts like this:
|
|
||||||
|
|
||||||
```flow
|
|
||||||
st=>start: Start
|
|
||||||
e=>end
|
|
||||||
op=>operation: My Operation
|
|
||||||
cond=>condition: Yes or No?
|
|
||||||
|
|
||||||
st->op->cond
|
|
||||||
cond(yes)->e
|
|
||||||
cond(no)->op
|
|
||||||
```
|
|
||||||
|
|
||||||
> **Note:** You can find more information:
|
|
||||||
|
|
||||||
> - about **Sequence diagrams** syntax [here][7],
|
|
||||||
> - about **Flow charts** syntax [here][8].
|
|
||||||
|
|
||||||
### Support StackEdit
|
|
||||||
|
|
||||||
[](https://monetizejs.com/authorize?client_id=ESTHdCYOi18iLhhO&summary=true)
|
|
||||||
|
|
||||||
[^stackedit]: [StackEdit](https://stackedit.io/) is a full-featured, open-source Markdown editor based on PageDown, the Markdown library used by Stack Overflow and the other Stack Exchange sites.
|
|
||||||
|
|
||||||
|
|
||||||
[1]: http://math.stackexchange.com/
|
|
||||||
[2]: http://daringfireball.net/projects/markdown/syntax "Markdown"
|
|
||||||
[3]: https://github.com/jmcmanus/pagedown-extra "Pagedown Extra"
|
|
||||||
[4]: http://meta.math.stackexchange.com/questions/5020/mathjax-basic-tutorial-and-quick-reference
|
|
||||||
[5]: https://code.google.com/p/google-code-prettify/
|
|
||||||
[6]: http://highlightjs.org/
|
|
||||||
[7]: http://bramp.github.io/js-sequence-diagrams/
|
|
||||||
[8]: http://adrai.github.io/flowchart.js/
|
|
||||||
|
|||||||
Reference in New Issue
Block a user