Z's learning note

Search

SearchSearch

obsidian

Dec 17, 2020, 8 min read

Obsidian.md

1 参考资料

2 文本

  • 彩色文本 <font color="red"> This text is red </font>

3 引用

3.1 测试用内容

  • 测试用内容

3.2 引用(标题引用，块引用)

  • 有两种对内容的引用方式，一种是通过标题，引用相应小节内的内容，另一种是引用一部分正文内容
    1. 通过#引用标题
    2. 通过^先标记再引用其它内容（link to block）
  • |后可将链接改为别名

3.2.1 显示引用内容

![[引用内容]] 如![[z.other/Software tools/Obsidian#测试用内容|测试用内容]]的效果为：

Transclude of block 测试用内容

3.2.2 不显示引用内容

[[引用内容]] 如[[z.other/Software tools/Obsidian#测试用内容|测试用内容]]的效果为： 测试用内容

3.2.3 块引用

  • 为引用块命名时注意其只支持字母数字和波折号
3.2.3.1.1 直接进行块引用
  • 使用方法：在需要引用的内容后加 ^your-block-name，注意在^应有空格
  • 测试内容 ^your-block-name
  • 引用测试内容 [[4.software/text_tools_paper-writing/obsidian#your-block-name|引用测试内容]]
3.2.3.2 块引用列表
  • 引用块的前后应有空行，块引用^block后也应有空行
3.2.3.2.1 测试用列表
3.2.3.3 块引用公式
  • 测试用内容：
$$
E = mc^2
$$
^einstein-relation

^einstein-relation

4 格式

4.1 图片调整大小

  • 有没有""不对单独使用造成影响，在表格中需要有""

    • 方法一：
    ![alt text\|400](your_image.jpg)
    • 方法二
    ![[reduction1.png\|600]]

    Resize images You can resize images using the following syntax:
    For markdown images, use ![AltText|100x100](https://url/to/image.png)
    For embeds, use ![[image.png|100x100]]
    To have the image scale according to its aspect ratio, omit the height ![[image.png|100]]

5 HTML

5.1 空格与换行

  • 没有内容的换行将打断html标签的解析

5.2 <img>引用图片

Obsidian forum

No, not directly. There are a couple workarounds: You can use an html tag if the image is hosted publicly (not a local file).

<img> HTML tag doesn’t work

  • Tested, works:
    • Windows: <img src="app://local/C://Users/username/Documents/obsidian_notebook/test.jpg">
    • Linux (you have to have two “/” before “home”): <img src="app://local//home/username/Documents/obsidian_notebook/test.jpg">
    • Mac (it doesn’t matter if you have one or two “/” before “Users”): <img src="app://local/Users/cusername/Documents/obsidian_notebook/test.jpg">

5.3 header numbering

head counter

6 Latex

6.1 竖线

  • 在表格中对|的解释有问题

    Workaroud: if you need | user \vert

数学公式

  • 在使用$$创建非嵌入的公式时，公式开头和结尾的$$应各占一行，否则有的导出HTML插件可能会出现问题，如 
    $$
y=ax+b
$$

7 插件

7.1 Quartz，将整个笔记发布为网站

  • 使用Quartz
    • 安装后删除content文件夹，建立软链接mklink /d (link) (target)
    • 配置文件quartz/quartz.config.ts
      • 忽略特定一类文件夹及其下所有文件（如文件夹名以private.开头）ignorePatterns: ["private", "templates", ".obsidian", ".git", "private.*/**/*"],
    • 预编译和测试（通过http://localhost:8080访问） npx quartz build --serve
    • 配置github workflow，新建.github/workflows/static.yml
    # Simple workflow for deploying static content to GitHub Pages
name: Deploy static content to Pages
 
on:
  # Runs on pushes targeting the default branch
  push:
    branches: ["master"]
 
  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:
 
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write
 
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false
 
jobs:
  # Single deploy job since we're just deploying
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Setup Pages
        uses: actions/configure-pages@v3
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v2
        with:
          # Upload entire repository
          path: '.'
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v2

7.2 为标题添加序号

  • 使用插件Number Heading Plugin for Obsidian
  • 在设置中配置为跳过第一级标题
  • 设置跳过标签，如^skip-numbering，可以放在标题后（有空格）从而不给该标题添加序号
  • 使用Ctrl+P呼出命令行，搜索命令Number headings
  • 更改序号先删除所有序号

8 开发插件

I want to develop a plugin, where do I start?

8.1 准备工作

  • 插件在.obsidian/plugins/中，每个文件夹对应一个插件，插件包含data.json，main.js和manifest.json
  • 开发者模式 ctrl+shift+I
  • 建议改动css的地方都放在vault —> .obsidian —> snippets里 做成css片段，然后在软件里启用片段

8.2 插件收集

Backlinks