GithubHelp home page GithubHelp logo

marslisiyuan / markdown Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 14 KB

markdown是一个程序员必备记笔记的工具,它支持windows,linux,max而且适用于很多的场合,清量、美观是它的优点

markdown's Introduction

markdown

markdown是一个程序员必备记笔记的工具,它支持windows,linux,max而且适用于很多的场合,清量、美观是它的优点

markdown:

[TOC]

对于markdown,是一个是个轻度排版,:smile:重度内容的软件,关于typora它也是特别简介的。

从我自己的角度上面,比较喜欢的OneNote,markdown,GitHub,vim,同样的,也有很多丰富的插件。

对于代码来说,无疑markdown是最好的选择之一,可以看下**C++**的代码模板:

#include<iostream>`

`uring namespace std;`

`int main()`

`{`

​		`cout<<"hello word"<<endl;`

​		`return 0;`

`}

mark down支持六种标题,分别对应的不同的样式。


怎么使用?

如果不算扩展,Markdown的语法绝对简单到让你爱不释手。

Markdown语法主要分为如下几大部分: 标题段落区块引用代码区块强调列表分割线链接图片反斜杠 \符号'`'

1.标题

两种形式: 1)使用=-标记一级和二级标题。

一级标题 ========= 二级标题 ---------

效果:

一级标题

二级标题

2)使用#,可表示1-6级标题。

# 一级标题 ## 二级标题 ### 三级标题 #### 四级标题 ##### 五级标题 ###### 六级标题

效果:

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

2 段落

段落的前后要有空行,所谓的空行是指没有文字内容。若想在段内强制换行的方式是使用两个以上空格加上回车(引用中换行省略回车)。

3 区块引用

在段落的每行或者只在第一行使用符号>,还可使用多个嵌套引用,如:

> 区块引用 >> 嵌套引用

效果:

区块引用

嵌套引用

4 代码区块

代码区块的建立是在每行加上4个空格或者一个制表符(如同写代码一样)。如 普通段落:

void main() { printf("Hello, Markdown."); }

代码区块:

void main()
{
    printf("Hello, Markdown.");
}

注意:需要和普通段落之间存在空行。

5 强调

在强调内容两侧分别加上*或者_,如:

斜体斜体 粗体粗体

效果:

斜体斜体 粗体粗体

6 列表

使用·+、或-标记无序列表,如:

-(+) 第一项 -(+) 第二项 - (+*)第三项

注意:标记后面最少有一个_空格_或_制表符_。若不在引用区块中,必须和前方段落之间存在空行。

效果:

  • 第一项
  • 第二项
  • 第三项

有序列表的标记方式是将上述的符号换成数字,并辅以.,如:

1 . 第一项 2 . 第二项 3 . 第三项

效果:

  1. 第一项
  2. 第二项
  3. 第三项

7 分割线

分割线最常使用就是三个或以上*,还可以使用-_

8 链接

链接可以由两种形式生成:行内式参考式行内式

smile的Markdown库

效果:

smile的Markdown库

参考式

smile的Markdown库1 smile的Markdown库2

效果:

smile的Markdown库1 smile的Markdown库2

注意:上述的[1]:https:://github.com/3293172751 "Markdown"不出现在区块中。

9 图片

添加图片的形式和链接相似,只需在链接的基础上前方加一个

10 反斜杠\

相当于反转义作用。使符号成为普通符号。

11 符号'`'

起到标记作用。如:

ctrl+a

效果:

ctrl+a

尝试一下

  • Chrome下的插件诸如stackeditmarkdown-here等非常方便,也不用担心平台受限。
  • 在线的dillinger.io评价也不错
  • Windowns下的MarkdownPad也用过,不过免费版的体验不是很好。
  • Mac下的Mou是国人贡献的,口碑很好。
  • Linux下的ReText不错。

当然,最终境界永远都是笔下是语法,心中格式化 :)。


注意:不同的Markdown解释器或工具对相应语法(扩展语法)的解释效果不尽相同,具体可参见工具的使用说明。 虽然有人想出面搞一个所谓的标准化的Markdown,[没想到还惹怒了健在的创始人John Gruber] (http://blog.codinghorror.com/standard-markdown-is-now-common-markdown/ )。


以上基本是所有traditonal markdown的语法。

其它:

列表的使用(非traditonal markdown):

|表示表格纵向边界,表头和表内容用-隔开,并可用:进行对齐设置,两边都有:则表示居中,若不加:则默认左对齐。

代码库 链接
MarkDown https://github.com/3293172751
MarkDownCopy https://github.com/3293172751

关于其它扩展语法可参见具体工具的使用说明。

表情:

在window或者Linux又或者是max同样有一个让人惊喜的功能,简单试一下

:输入你要输入的英文或者数字

:smile

或者用快捷键**win + 。**😊这是Windows自带的表情标签

markdown插入图片:

markdown插入图片是一个很特别的功能,并不仅仅是你复制粘贴所得到的那么简明。

它复杂的功能带来了更好的体验。

在你引用本地图片的时候,如果将图片删除后,那么你的图片也会消失,这样会增加很多的维护成本。

如何解决:frowning::

  • 你可以选择网上的图片路径,对路径的地址进行拷贝,在粘贴为图像路径,基本上图片不会失效。
  • 图床**:
    • PicGo --适用于windows
图片的排版:

​ 使用HTML对图片基本操作


同样要补充的是:

​ 在你使用GitHub做笔记,上传项目,或者是做个人博客的时候,GitHub一般选择的是图床,即你不会将GitHub上面的图片。

而是一般选择将你的图片上传到一个服务器或者是上传到一个平台,使用特有的连接去访问。

关于GitHub的Pic Go仓库是一个开源的,可以免费使用的仓库。

PicGo-Setup下载之后即可直接进行安装,使用,你就不用担心自己的GitHub或者你的博客卡顿问题了

这个是GitHub上面的下载地址:https://github.com/Molunerfinn/PicGo/releases/download/v2.3.0/PicGo-Setup-2.3.0-x64.exe

你可以使用你的GitHub用来存放图片,但是我不建议这么做,GitHub在国内的下载速度很慢,可能会出现图片加载速度缓慢的情况😂

markdown's People

Contributors

cubxxw avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.