如何写笔记

新建页面

有2种创建新页面的方式，2种方式各有利弊。

  1. 以文件夹方式
  2. 单md文件方式

以文件夹方式

以文件夹方式就是在对应分类文件夹（blog或docs）下面，新建一个文件夹，然后在新建的文件夹里面，新建index.md文件，在index.md里面创作内容。

单md文件方式

以单.md文件方式，就是直接在对应分类文件夹（blog或docs）下面新建xxx.md的方式，然后在xxx.md里面创作内容。

以文件夹方式的好处

以文件夹方式的好处是可以直接将图片放在文件夹内，index.md里直接引用图片即可展示，后面介绍引用图片的时候会详细说明。

页面信息

我们写文档的时候，可以设置一些页面信息，主要涉及以下方面

  • 文章标题
  • 简介
  • 写作日期
  • 作者
  • 排序
  • 分类
  • 标签
---
# 标题
title: "笔记标题"
# 简介
excerpt: "如何写笔记"
# 写作日期
date: 2023-04-04
# 作者
contributors: ["Dennis"]
# 排序，越小越靠前
weight: 1
# 分类
categories: ["帮助"]
# 标签
tags: ["笔记", "博客", "文章"]
---

只需要以---开头，中间设置页面信息属性，并以---结尾即可。

页面内容

笔记内容我们以Markdown的格式来书写，具体如何写，请参考Markdown教程

除了支持基本的Markdown语法外，还扩展了一些功能

  • 展示代码
  • 引用图片
  • 详情
  • 提醒

展示代码 

class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}

如上所示，有时候我们需要展示代码，这时我们可以使用代码块标记，示例如下：

``` java
class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}
```

以```开头，紧随的是代码的语言，比如java，最后记得以```结尾

引用图片

我们写文档时，往往需要展示图片，根据你创建页面的方式不同，有2种不同的方式放置和引用图片。

局部图片

demo

如果以新建文件夹的方式创建了页面，则可以将图片放在文件夹内，然后使用相对路径来进行引用。

如本文在/content/cn/docs/下，新建了how-to-write-docs文件夹，将demo.png放在了里面，则可以直接引用demo.png，示例如下：

<img src="demo.png" width="300">

全局图片

demo

如果你以单md文件的方式创建了页面，或者你想中文内容和英文内容共享图片，也可以使用全局的方式。

只需要将图片放在/static/images目录下，使用绝对路径引用即可，如demo.png也在/static/images放置了一份，示例如下：

<img src="/images/demo.png" width="375">
demo

详情

点击我展开详情 你看不到我，除非你点击展开详情。

有时候，我们不想把过多的内容一次性展示出来，想点击一下才展示更多信息，则可以使用详情标签，示例如下：

提醒

有时候，我们想特别标注一下，则可以使用提醒功能，示例如下：

Last modified on April 9, 2023
← Git起步