My Blog Template



用户手册

本文章致力于让电脑小白能够轻松在此博客模板上建立自己的网页，如有任何疑问或建议，欢迎联系我。以下是基于windows系统下的操作方式，如有使用其他系统的同学，请联系我。

对该博客模板功能的任何建议可以在项目issue tracker上发表。

环境配置

  • 下载并安装git：git官网

  • 在你任意一个想要建立工程的位置创建一个空的文件夹

  • 在你的文件夹中的空白处右键选择在终端中打开

    zd

  • 使用以下命令进行初始化：

    git config --global user.name "Your Name"
git config --global user.email "your_email@example.com"

  • 可以通过以下命令查看当前配置的用户名和邮箱：

    git config --global --list

  • 输入以下命令初始化Git仓库：

    git init

  • 使用以下命令添加远程仓库：

    git remote add origin https://gitlab.com/MinatoooKira/gatsby-iweb.git

  • 你可以使用以下命令来查看当前仓库的远程信息：

    git remote -v

  • 使用以下命令来克隆仓库：

    git clone https://gitlab.com/MinatoooKira/gatsby-iweb.git

创建并编辑新的页面

方法1：使用Obsidian进行内容创建（用户界面友好，适合markdown新手）

  1. 下载并安装Obsidian：Obsidian官网

  2. 根据指引创建Obsidian仓库。

  3. 关闭安全模式并安装插件：Edit MDX

    plugin

  4. 创建.mdx文件，输入---（三个减号）以编辑笔记属性。

    • title 是页面标题，决定了你的页面在目录中展示的内容。
    • slug 是访问页面的指针，例如：
    • 我们可以根据需求设计其他不同的属性，如class决定该文章的类别，preview决定该页面是否可预览。
    new

  5. 使用Markdown/MarkdownX编辑你的页面：

    • Markdown基本教程
      • 基本语法
      • 扩展语法
      • 一点额外的提醒：如果你想在页面中添加图片，请将图片文件放在assets文件夹（在之前克隆的仓库里面），并以如下格式插入图片。 
        ![你的图片](https://gitlab.com/MinatoooKira/gatsby-iweb/-/raw/main/assets/图片文件名.文件后缀)

  6. 将你的页面添加到项目中：

    • 在Obsidian中右键文件，选择在系统资源管理器中显示。
    • 将你的.mdx文件转移至blog文件夹（在之前克隆的仓库里面）中。

  7. 上传：

    • 回到你在环境配置步骤中创建的那个文件夹。

    • 在你的文件夹内中的空白处右键选择在终端中打开

      zd

    • 使用以下命令进行上传

      git add .
git commit -m "user-update"
git push origin main

    • 等待几分钟后，你便可以在MDXContents目录中看到你的新页面了。

方法2：使用VSCode进行内容创建（推荐，有利于后续自定义插件的使用）

  1. 下载并安装VSCode：VSCode官网

  2. 在blog文件夹（在之前克隆的仓库里面）下运行VSCode

    openvsc

  3. 下载必要的插件：MDX和MDX Preview

    vscplugin

  4. 创建.mdx文件，编写Frontmatter

    ---
title: your-title
slug: your-slug
preview: shown or unshown
---
    • title 是页面标题，决定了你的页面在目录中展示的内容。
    • slug 是访问页面的指针，例如：
    • 我们可以根据需求设计其他不同的属性，如class决定该文章的类别，preview决定该页面是否可预览。

  5. 上传：

  • 编辑完成后，回到你在环境配置步骤中创建的那个文件夹。

  • 在你的文件夹内中的空白处右键选择在终端中打开

    zd

  • 使用以下命令进行上传

    git add .
git commit -m "user-update"
git push origin main

  • 等待几分钟后，你便可以在MDXContents目录中看到你的新页面了。

方法3：使用本网站提供的MDX实时渲染编辑器（适合临时使用，或用于学习练习Markdown语法）

感谢您的耐心阅读

如若需要特定的自定义插件支持，请联系我。

其他页面