Markdown的使用

MarkDown的使用

如何设置标题

  可以在标题内容前输入特定数量的井号('#')来实现对应级别的HTML样式的标题(HTML提供六级标题)。

如何设置缩进

  可以在段首加入 来输入一个空格。加入 来输入两个空格。

如何插入代码

  单行代码使用一对` (Esc键下边的那个,而不是单引号)包括,内部不可以换行
例如:

public String updatepassword(String oldPassword, String newPassword, String newPasswordConfirm, HttpServletRequest request) throws Exception ;

插入代码的方式有两种:
方式一:在每行代码前加入4个空格或者添加一个制表符(TAB键)
方式二:在代码前后两行添加三个反引号(```)。
  方式一举例

@RequestMapping("/index.do")
	public String index(HttpServletRequest request) {
		try {
			HttpSession sesion = request.getSession();
			Boolean ret = userFun.checkUserLogin(sesion);
			if (ret) {
				System.out.println("用户已登录");
			}else {
				System.out.println("用户没有登录");
			}
		} catch (Exception e) {
			// TODO: handle exception
			request.setAttribute("message", e.getMessage());
			return "forward:/login.jsp";
		}
		
		return "index";
	}

  方式二举例
  PS. 这里可以指定代码所属的语言,只要在第一组反引号后面添加相应的语言名称即可。

@RequestMapping("/login.do")
	public String login(String account, String password, HttpServletRequest request) {
		
		try {
			UserEntity user = userFun.login(account, password);
			HttpSession session = request.getSession();
			session.setAttribute("currentUser", user);
			System.out.println(user.getName());
		} catch (Exception e) {
			// TODO: handle exception
			request.setAttribute("message", e.getMessage());
			return "forward:/login.jsp";
		}
		
		return "redirect:/index.do";
	}

文档中用到了MarkDown语法中的符号:

符号转义:

  如果你的描述中需要用到 markdown 的符号,比如 _ # * 等,但又不想它被转义,这时候可以在这些符号前加反斜杠,如 _ # * 进行避免。

设置语法高亮

  在``(两个反引号)之间的文字会被高亮显示。

例如:GitHub现在成了主流,不仅提供Git代码托管(取代SVN)、ssue追踪(取代JIRA

如何结束先前的格式状态?

  在改变格式时,添加一个空行。
  PS.这是空行的妙用的其中一个地方,另外,段与段之间建议加一个空行,因为在某些平台上,如果段与段之间没有空行的话,两段内容会柔和在一起,这是不同平台对Markdown语法的解析不同有关,为了防止兼容性问题建议大家在段与段之间建议加一个空行。

网址链接

  书写格式:
  [我的博客](https://www.cnblogs.com/Ape-son/p/7242297.html)

  表现形式:
  我的博客

posted @ 2017-07-26 22:08  BeyondHeaven  阅读(140)  评论(0编辑  收藏  举报