Files
remark42/frontend/markdown-help.html
T
Dmitry VerkhoturovandUmputun d23d119d70 Add API methods for setting and deleting email (#483)
* add API methods for setting and deleting email

* fix service.SetStringUserDetail signature to return string

* switch table test with description to t.Run()

* remove debug logging

* clarify error handling, functions names

* add email integration test

* add information about email subscription to readme

* change email API calls method from PUT to POST

* typo fix, remove unneeded capturing of range variable

* email test draft

* fix notify mock, email notification test draft

* add MockDestination to startupT return

* fix tests

* add email retrieval for notifications sending

* fix mock for notify

* rearrange mock notify declaration

* add GET /email API handler, fix typos

* revert startupT signature change

* get rid of startupTWithDest workaround

* add rest examples for rest notification

* improve email messages formatting

* fix email send repeater location

* remove unneeded context from sendMessage

* change signatures of buildMessage functions to have same field name

* add missing authenticate call on TLS connection

* add dev user auth token to email requests

* change email verification template

* email code and tests cleanup

* replace fixed spaces with normal ones

* human-readable variables names for new comment reply notification

* rename Comment to CommentText

* add html for comment email notification

* fix comment notification html style

* fix email test

* fix notify email messages rendering

* fix comments on rest examples for email

* explicitly state email notify email template fields

* clarify email API documentation

* change email test not to check quoted-printable part of message

* Fix link color, add unsubscribe link

* fix rest examples tokens

* add UnsubscribeLink support to Email

* add unsubscribe email handler

* fix new reply notification email style
2019-12-16 16:39:55 -06:00

416 lines
9.6 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!doctype html>
<html class="no-js" lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>How to use Markdown in Remark</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<style>
html {
color: #222;
font-size: 1em;
line-height: 1.4;
}
hr {
display: block;
height: 1px;
border: 0;
border-top: 1px solid #ccc;
margin: 1em 0;
padding: 0;
}
a {
color: #4183c4;
}
audio,
canvas,
iframe,
img,
svg,
video {
vertical-align: middle;
}
fieldset {
border: 0;
margin: 0;
padding: 0;
}
textarea {
resize: vertical;
}
.browserupgrade {
margin: 0.2em 0;
background: #eee;
color: #000;
padding: 0.2em 0;
}
body {
font: 16px/26px Helvetica, Helvetica Neue, Arial;
}
.wrapper {
width: 90%;
margin: 0 5%;
}
.title {
color: #222;
margin: 40px 0 0 0;
}
nav ul {
margin: 0;
padding: 0;
list-style-type: none;
}
nav a {
display: block;
margin-bottom: 10px;
padding: 15px 0;
text-align: center;
text-decoration: none;
font-weight: bold;
color: #222;
}
nav a:hover,
nav a:visited {
color: #222;
}
nav a:hover {
text-decoration: underline;
}
.main {
padding: 30px 0;
}
.main article h1 {
font-size: 2em;
}
.main aside {
color: #222;
padding: 20px 40px;
}
.main aside p {
margin: 0 0 20px 0;
padding: 0;
font-size: 1.2em;
}
.main aside p:last-child {
margin-bottom: 0;
}
.footer-container footer {
color: #222;
padding: 20px 0;
}
.ie7 .title {
padding-top: 20px;
}
@media only screen and (min-width: 480px) {
nav a {
float: left;
width: 27%;
margin: 0 1.7%;
padding: 25px 2%;
margin-bottom: 0;
}
nav li:first-child a {
margin-left: 0;
}
nav li:last-child a {
margin-right: 0;
}
nav ul li {
display: inline;
}
.oldie nav a {
margin: 0 0.7%;
}
}
@media only screen and (min-width: 768px) {
nav {
float: right;
width: 38%;
}
.main article {
float: left;
width: 57%;
}
.main aside {
float: right;
width: 28%;
}
}
@media only screen and (min-width: 1140px) {
.wrapper {
width: 1026px;
/* 1140px - 10% for margins */
margin: 0 auto;
}
}
.hidden {
display: none !important;
visibility: hidden;
}
.visuallyhidden {
border: 0;
clip: rect(0 0 0 0);
height: 1px;
margin: -1px;
overflow: hidden;
padding: 0;
position: absolute;
width: 1px;
}
.visuallyhidden.focusable:active,
.visuallyhidden.focusable:focus {
clip: auto;
height: auto;
margin: 0;
overflow: visible;
position: static;
width: auto;
}
.invisible {
visibility: hidden;
}
.clearfix:before,
.clearfix:after {
content: " ";
display: table;
}
.clearfix:after {
clear: both;
}
.clearfix {
*zoom: 1;
}
@media print {
*,
*:before,
*:after {
background: transparent !important;
color: #000 !important;
box-shadow: none !important;
text-shadow: none !important;
}
aside {
display: none;
}
a,
a:visited {
text-decoration: underline;
}
a[href]:after {
content: " ("attr(href) ")";
}
abbr[title]:after {
content: " ("attr(title) ")";
}
a[href^="#"]:after,
a[href^="javascript:"]:after {
content: "";
}
pre,
blockquote {
border: 1px solid #999;
page-break-inside: avoid;
}
thead {
display: table-header-group;
}
tr,
img {
page-break-inside: avoid;
}
img {
max-width: 100% !important;
}
p,
h2,
h3 {
orphans: 3;
widows: 3;
}
h2,
h3 {
page-break-after: avoid;
}
}
</style>
</head>
<body>
<div class="header-container">
<header class="wrapper clearfix">
<a id="Introduction"></a>
<h1 class="title">How to use Markdown in Remark</h1>
</header>
</div>
<div class="main-container">
<div class="main wrapper clearfix">
<article>
<p>Markdown is a lightweight and easy-to-use syntax for styling
Remark comments. You control the display of the comment,
formatting words as bold or italic, adding images, and
creating lists are just a few of the things we can do with
Markdown.</p>
<h2 id="Headers-Quotes">Headers & Quotes</h2>
<p>Sometimes it's useful to have different levels of headings
to structure your comments. Start lines with a `#` to
create headings.</p>
<p>You can use one `#` all the way up to `######` six for
different heading sizes.</p>
<p>If youd like to quote someone, use the > character before
the line</p>
<h2 id="Text">Text</h2>
<p>It's very easy to make some words <strong>bold</strong>:
surround them with double asterisks **
and other words <em>italic</em>: surround them with one
asterisk *.</p>
<p>You can even <a href="http://google.com"
target="_blank">link to Google!</a> using this syntax:<br>
[link to Google!](http://google.com)</p>
<h2 id="Lists">Lists</h2>
<p>If you want numbered lists:</p>
<p>
1. One<br>
2. Two<br>
3. Three<br>
3.1. Item 3.1<br>
3.2. Item 3.2<br>
</p>
<p>If you want bullet point</p>
<p>
* Item 1<br>
* Item 2<br>
* Item 2a<br>
* Item 2b<br>
</p>
<h2 id="Images">Images</h2>
<p>If you want to embed images, this is how you do it:</p>
<p>
<pre>![Image of my cat]
(https://placekitten.com/400/400)</pre>
<img src="https://placekitten.com/400/400" width="400" height="400">
</p>
<h2 id="Code">Code</h2>
<p>You can create code span by wrapping
text in backtick quotes: <strong>`your code`</strong></p>
<h2 id="Tables">Tables</h2>
<p>You can create tables by assembling a list of words and
dividing them with hyphens - (for the first row), and then
separating each column with a pipe |:</p>
<pre>
|First Header | Second Header|
|------------ | -------------|
|Content from cell 1 | Content from cell 2|
|Content in the first column | Content in the second column|
</pre>
</article>
<aside>
<p>
<a href="#Introduction">Introduction</a>
</p>
<p>
<a href="#Headers-Quotes">Headers &amp; Quotes</a>
</p>
<p>
<a href="#Text">Text</a>
</p>
<p>
<a href="#Lists">Lists</a>
</p>
<p>
<a href="#Images">Images</a>
</p>
<p>
<a href="#Code">Code</a>
</p>
<p>
<a href="#Tables">Tables</a>
</p>
</aside>
</div>
</div>
</body>
</html>