Permalink
Browse files

theme preview update

  • Loading branch information...
xianmin committed Mar 7, 2018
1 parent d011b31 commit 9a3c0b0284efa70541f820812c6bb9ac333b7049
View
@@ -1,5 +1,5 @@
baseURL = "http://en.xianmin.org/hugo-theme-jane/"
defaultContentLanguage = "zh-CN"
defaultContentLanguage = "en"
title = "Jane - A simple theme for Hugo"
enableRobotsTXT = true
enableEmoji = true
@@ -0,0 +1,339 @@
---
title: "Jane Theme Preview"
date: 2018-03-06T16:01:23+08:00
lastmod: 2018-03-07T16:01:23+08:00
draft: false
tags: ["preview", "shortcodes", "tag-6"]
categories: ["shortcodes", "index"]
author: "Typora"
# You can also close(false) or open(true) something for this content.
# P.S. comment can only be closed
# comment: false
# toc: false
# You can also define another contentCopyright. e.g. contentCopyright: "This is another copyright."
contentCopyright: '<a href="https://github.com/gohugoio/hugoBasicExample" rel="noopener" target="_blank">See origin</a>'
# reward: false
mathjax: true
---
**Markdown** is created by [Daring Fireball](http://daringfireball.net/), the original guideline is [here](http://daringfireball.net/projects/markdown/syntax). Its syntax, however, varies between different parsers or editors.
Please note that HTML fragments in markdown source will be recognized but not parsed or rendered. Also, there may be small reformatting on the original markdown source code after saving.
<!--more-->
## Paragraph and line breaks
A paragraph is simply one or more consecutive lines of text. In markdown source code, paragraphs are separated by more than one blank lines. In Typora, you only need to press `Return` to create a new paragraph.
Press `Shift` + `Return` to create a single line break. However, most markdown parser will ignore single line break, to make other markdown parsers recognize your line break, you can leave two whitespace at the end of the line, or insert `<br/>`.
## Headers
Headers use 1-6 hash characters at the start of the line, corresponding to header levels 1-6. For example:
``` markdown
# This is an H1
## This is an H2
###### This is an H6
```
In typora, input ‘#’s followed by title content, and press `Return` key will create a header.
## Blockquotes
Markdown uses email-style > characters for block quoting. They are presented as:
> This is a blockquote with two paragraphs. This is first paragraph.
>
> This is second pragraph.Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
> This is another blockquote with one paragraph. There is three empty line to seperate two blockquote.
In typora, just input ‘>’ followed by quote contents a block quote is generated. Typora will insert proper ‘>’ or line break for you. Block quote inside anther block quote is allowed by adding additional levels of ‘>’.
## Lists
Input `* list item 1` will create an un-ordered list, the `*` symbol can be replace with `+` or `-`.
Input `1. list item 1` will create an ordered list, their markdown source code is like:
* Red
* Green
* Blue
1. Red
2. Green
3. Blue
## Task List
Task lists are lists with items marked as either [ ] or [x] (incomplete or complete). For example:
- [ ] a task list item
- [ ] list syntax required
- [ ] normal **formatting**, @mentions, #1234 refs
- [ ] incomplete
- [x] completed
You can change the complete/incomplete state by click the checkbox before the item.
## Syntax Highlighting
```js
function helloWorld () {
alert("Hello, World!")
}
```
```java
public class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello, World!");
}
}
```
## Math Blocks
You can render *LaTeX* mathematical expressions using **MathJax**.
Input `$$`, then press 'Return' key will trigger an input field which accept *Tex/LaTex* source. Following is an example:
$$
\mathbf{V}_1 \times \mathbf{V}_2 = \begin{vmatrix}
\mathbf{i} & \mathbf{j} & \mathbf{k} \\
\frac{\partial X}{\partial u} & \frac{\partial Y}{\partial u} & 0 \\
\frac{\partial X}{\partial v} & \frac{\partial Y}{\partial v} & 0 \\
\end{vmatrix}
$$
In markdown source file, math block is *LaTeX* expression wrapped by ‘$$’ mark:
``` markdown
$$
\mathbf{V}_1 \times \mathbf{V}_2 = \begin{vmatrix}
\mathbf{i} & \mathbf{j} & \mathbf{k} \\
\frac{\partial X}{\partial u} & \frac{\partial Y}{\partial u} & 0 \\
\frac{\partial X}{\partial v} & \frac{\partial Y}{\partial v} & 0 \\
\end{vmatrix}
$$
```
## Tables
Input `| First Header | Second Header |` and press `return` key will create a table with two column.
After table is created, focus on that table will pop up a toolbar for table, where you can resize, align, or delete table. You can also use context menu to copy and add/delete column/row.
Following descriptions can be skipped, as markdown source code for tables are generated by typora automatically.
In markdown source code, they look like:
``` markdown
| First Header | Second Header |
| ------------- | ------------- |
| Content Cell | Content Cell |
| Content Cell | Content Cell |
```
| First Header | Second Header |
| ------------- | ------------- |
| Content Cell | Content Cell |
| Content Cell | Content Cell |
## Footnotes
``` markdown
You can create footnotes like this[^footnote].
[^footnote]: Here is the *text* of the **footnote**.
```
will produce:
You can create footnotes like this[^footnote].
[^footnote]: Here is the *text* of the **footnote**.
Mouse on the ‘footnote’ superscript to see content of the footnote.
## Horizontal Rules
Input `***` or `---` on a blank line and press `return` will draw a horizontal line.
------
## Links
Markdown supports two style of links: inline and reference.
In both styles, the link text is delimited by [square brackets].
To create an inline link, use a set of regular parentheses immediately after the link text’s closing square bracket. Inside the parentheses, put the URL where you want the link to point, along with an optional title for the link, surrounded in quotes. For example:
``` markdown
This is [an example](http://example.com/ "Title") inline link.
[This link](http://example.net/) has no title attribute.
```
will produce:
This is [an example](http://example.com/"Title") inline link. (`<p>This is <a href="http://example.com/" title="Title">`)
[This link](http://example.net/) has no title attribute. (`<p><a href="http://example.net/">This link</a> has no`)
### Internal Links
**You can set the href to headers**, which will create a bookmark that allow you to jump to that section after clicking. For example:
Command(on Windows: Ctrl) + Click [This link](#block-elements) will jump to header `Block Elements`. To see how to write that, please move cursor or click that link with `⌘` key pressed to expand the element into markdown source.
### Reference Links
Reference-style links use a second set of square brackets, inside which you place a label of your choosing to identify the link:
``` markdown
This is [an example][id] reference-style link.
Then, anywhere in the document, you define your link label like this, on a line by itself:
[id]: http://example.com/ "Optional Title Here"
```
In typora, they will be rendered like:
This is [an example][id] reference-style link.
[id]: http://example.com/ "Optional Title Here"
The implicit link name shortcut allows you to omit the name of the link, in which case the link text itself is used as the name. Just use an empty set of square brackets — e.g., to link the word “Google” to the google.com web site, you could simply write:
``` markdown
[Google][]
And then define the link:
[Google]: http://google.com/
```
In typora click link will expand it for editing, command+click will open the hyperlink in web browser.
## URLs
Typora allows you to insert urls as links, wrapped by `<`brackets`>`.
`<i@typora.io>` becomes <i@typora.io>.
Typora will aslo auto link standard URLs. e.g: www.google.com.
## Images
Image looks similar with links, but it requires an additional `!` char before the start of link. Image syntax looks like this:
``` markdown
![Alt text](/path/to/img.jpg)
![Alt text](/path/to/img.jpg "Optional title")
```
You are able to use drag & drop to insert image from image file or we browser. And modify the markdown source code by clicking on the image. Relative path will be used if image is in same directory or sub-directory with current editing document when drag & drop.
For more tips on images, please read <http://support.typora.io//Images/>
## Emphasis
Markdown treats asterisks (`*`) and underscores (`_`) as indicators of emphasis. Text wrapped with one `*` or `_` will be wrapped with an HTML `<em>` tag. E.g:
``` markdown
*single asterisks*
_single underscores_
```
output:
*single asterisks*
_single underscores_
GFM will ignores underscores in words, which is commonly used in code and names, like this:
> wow_great_stuff
>
> do_this_and_do_that_and_another_thing.
To produce a literal asterisk or underscore at a position where it would otherwise be used as an emphasis delimiter, you can backslash escape it:
``` markdown
\*this text is surrounded by literal asterisks\*
```
Typora recommends to use `*` symbol.
## Strong
double *’s or _’s will be wrapped with an HTML `<strong>` tag, e.g:
``` markdown
**double asterisks**
__double underscores__
```
output:
**double asterisks**
__double underscores__
Typora recommends to use `**` symbol.
## Code
To indicate a span of code, wrap it with backtick quotes (`). Unlike a pre-formatted code block, a code span indicates code within a normal paragraph. For example:
``` markdown
Use the `printf()` function.
```
will produce:
Use the `printf()` function.
## Strikethrough
GFM adds syntax to create strikethrough text, which is missing from standard Markdown.
`~~Mistaken text.~~` becomes ~~Mistaken text.~~
## Underline
Underline is powered by raw HTML.
`<u>Underline</u>` becomes <u>Underline</u>.
## Emoji :happy:
Input emoji with syntax `:smile:`.
User can trigger auto-complete suggestions for emoji by pressing `ESC` key, or trigger it automatically after enable it on preference panel. Also, input UTF8 emoji char directly from `Edit` -> `Emoji & Symbols` from menu bar is also supported.
## Inline Math
To use this feature, first, please enable it in `Preference` Panel -> `Markdown` Tab. Then use `$` to wrap TeX command, for example: `$\lim_{x \to \infty} \exp(-x) = 0$` will be rendered as LaTeX command.
To trigger inline preview for inline math: input “$”, then press `ESC` key, then input TeX command, a preview tooltip will be visible like below:
<img src="http://typora.io/img/inline-math.gif" style="zoom:50%;" />
View
BIN +106 KB images/preview.png
Binary file not shown.
View
BIN +162 KB (370%) images/screenshot.png
Binary file not shown.
View
BIN +102 KB images/tn.png
Binary file not shown.

0 comments on commit 9a3c0b0

Please sign in to comment.