Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #63

Merged
merged 4 commits into from
Mar 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,3 @@ body:
id: rationale
attributes:
label: Why is this needed?
validations:
required: true
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/support.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: Support
description: Finding support on how to use the plugin
labels: ['support']
body:
- type: textarea
id: problem
attributes:
label: What do you need to help with?
validations:
required: true
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2023 Chiyu Liang
Copyright (c) 2023-2024 Chiyu Liang

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
19 changes: 8 additions & 11 deletions docs/CONTRIBUTING-ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## 设计原则

本插件计划提供的功能需要至少满足下列条件中的一条
本插件计划提供的功能需要满足下列条件中的至少一条

- 助力化学科研笔记,如实验记录、文献阅读笔记、论文大纲撰写等
- 帮助构建与常用化学工具紧密协作的工作流
Expand All @@ -23,6 +23,8 @@
- 本仓库提供了 issue 模板,请按照模板指引填写,以提供必要的内容
- 为您需要的功能点赞👍!投票人数更多的功能请求将被优先考虑

同样欢迎通过 issue 咨询插件使用问题,以及展示您的使用样例!

## 提交 PR

### 注意事项
Expand All @@ -37,30 +39,30 @@
cd [你的工作文件夹]
```

> **Note**
> [!Note]
> 建议使用一个开发 vault 的配置文件夹作为本插件的工作文件夹。例如 `.obsidian\plugins\)`.

```cmd
git clone https://github.com/Acylation/obsidian-chem.git chem
cd chem
```

> **Note**
> [!Note]
> 本插件的 id 是 `chem` 而不是 `obsidian-chem`

### Install dependencies
### 安装依赖

```cmd
npm install
```

### Developing
### 进行开发

```cmd
npm run dev
```

> **Note**
> [!Note]
> 该命令执行后,将监听源代码的更改,并在保存更改时自动编译出一个新版的`main.js`
> 下载并启用 [Hot-Reload](https://github.com/pjeby/hot-reload) 插件以获得流畅的开发体验

Expand All @@ -82,9 +84,4 @@ npm run build
- 需要针对特定代码提出疑问、提供建议等,请在提交 PR 后使用 GitHub 的 code review 功能
- 您提交的PR将在审核后被合并,或被要求修改

## 仍有疑问?

- 如果您有任何疑问,或需要帮助,请在本仓库下的 [Discussions](https://github.com/Acylation/obsidian-chem/discussions) 栏目中发帖询问
- 若您希望展示您的使用案例,也欢迎前往 [Discussions](https://github.com/Acylation/obsidian-chem/discussions) 栏目

感谢您成为本项目的一份子!🙌
12 changes: 5 additions & 7 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ As an Obsidian plugin, this project adheres to the following principles:
- When creating a new issue, please follow the templates to provide necessary information.
- You can also vote for existing issues by adding a 👍 reaction to show your support.

You are also welcome to raise questions that you came across when using this plugin, or provide awesome showcases through issue!

## How to submit a pull request

### General
Expand All @@ -37,15 +39,15 @@ As an Obsidian plugin, this project adheres to the following principles:
cd [your-working-folder]
```

> **Note**
> [!Note]
> It is recommended to use the config directory of a dev vault (e.g., .obsidian\plugins\\) as the working directory.

```cmd
git clone https://github.com/Acylation/obsidian-chem.git chem
cd chem
```

> **Note**
> [!Note]
> The plugin id in the manifest is `chem` rather than `obsidian-chem`.

### Install dependencies
Expand All @@ -60,7 +62,7 @@ npm install
npm run dev
```

> **Note**
> [!Note]
> This command will listen for changes to the source code and provide a new build when you save changes.
> Download and enable the [Hot-Reload](https://github.com/pjeby/hot-reload) plugin to experience a smooth debugging workflow.

Expand All @@ -82,8 +84,4 @@ npm run build
- For raising questions, providing suggestions, or explaining a specific line of code, please use GitHub’s code review feature.
- Please wait for a review before your pull request being merged.

## Still have questions?

- If you still have any questions or need help with using or developing this project, please join our [Discussions](https://github.com/Acylation/obsidian-chem/discussions) right here in the repo.

Thank you for being a part of this project! 🙌
Loading