跳转至

Obsidian is a Markdown-based note-taking and knowledge base app.

We currently support the formats below:


Headers#

This is a heading 1#

This is a heading 2#

This is a heading 3#

This is a heading 4#

This is a heading 5#
This is a heading 6#

Emphasis#

This text will be italic
This will also be italic

This text will be bold
This will also be bold

You can combine them


Lists#

  • Item 1
  • Item 2
  • Item 2a
  • Item 2b

  • Item 1

  • Item 2
  • Item 3
  • Item 3a
  • Item 3b

Images#

Engelbart


http://obsidian.md - automatic!
Obsidian

Markdown style links can be used to refer to either external objects, such as web pages, or an internal page or image. If there are spaces in the url, they can be escaped by either using %20 as a space, such as Export options, or by enclosing the target in <>, such as Slides Demo.


Blockquotes#

Human beings face ever more complex and urgent problems, and their effectiveness in dealing with these problems is a matter that is critical to the stability and continued progress of society.

- Doug Engelbart, 1961


Inline code#

Text inside backticks on a line will be formatted like code.


Code blocks#

Syntax highlight is supported with the language specified after the first set of backticks. We use prismjs for syntax highlighting, a list of supported languages can be found at their site

function fancyAlert(arg) {
  if(arg) {
    $.facebox({div:'#foo'})
  }
}
Text indented with a tab is formatted like this, and will also look like a code block in preview.

Task list#

  • #tags, links, formatting supported
  • list syntax required (any unordered or ordered list supported)
  • this is a complete item
  • this is an incomplete item
  • tasks can be clicked in Preview to be checked off

Tables#

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 |:

First Header Second Header
Content from cell 1 Content from cell 2
Content in the first column Content in the second column

Tables can be justified with a colon Another example with a long title
because of the : these will be justified

If you put links in tables, they will work, but if you use Piped Links, the pipe must be escaped with a \ to prevent it being read as a table element.

First Header Second Header
[[Format your notes|Formatting]] [[Keyboard shortcuts|hotkeys]]

Strikethrough#

Any word wrapped with two tildes (like this) will appear crossed out.


Footnotes#

Here's a simple footnote,1 and here's a longer one.2

You can also use inline footnotes. ^[notice that the carat goes outside of the brackets on this one.]

Math#

\begin{vmatrix}a & b\\ c & d \end{vmatrix}=ad-bc

You can also do inline math like e^{2i\pi} = 1 .

Obsidian specific#

Highlighting#

Use two equal signs to highlight text.

Internal linking#

Link to a page: Internal link.

Internal embeds#

Embed another file (read more about Embed files).

Obsidian

Developer notes#

We strive for maximum capability without breaking any existing formats, therefore we use a slightly unorthodox combination of flavors of markdown. It is broadly CommonMark, with the addition of some functionality from GitHub Flavored Markdown (GFM), some latex support, and our chosen embed syntax, which you can read more about at Accepted file formats.


  1. meaningful! 

  2. Here's one with multiple paragraphs and code.

    Indent paragraphs to include them in the footnote.

    { my code }

    Add as many paragraphs as you like.