Early configurations

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,47 @@
+name: Bug Report
+description: Report a bug encountered while using the Chem plugin
+labels: ['triage']
+body:
+    - type: textarea
+      id: problem
+      attributes:
+          label: What happened?
+          description: |
+              Please provide as much info as possible.
+      validations:
+          required: true
+
+    - type: textarea
+      id: expected
+      attributes:
+          label: What did you expect to happen?
+      validations:
+          required: true
+
+    - type: textarea
+      id: repro
+      attributes:
+          label: How can we reproduce it (as minimally and precisely as possible)?
+      validations:
+          required: true
+
+    - type: textarea
+      id: additional
+      attributes:
+          label: Anything else we need to know?
+
+    - type: input
+      id: pluginVersion
+      attributes:
+          label: Plugin version
+          description: You can find the version under Settings -> Community plugins -> Installed plugins -> Chem.
+      validations:
+          required: true
+
+    - type: input
+      id: obsidianVersion
+      attributes:
+          label: Obsidian version
+          description: You can find the version under Settings -> About -> Current version.
+      validations:
+          required: true

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,17 @@
+name: Feature Request
+description: Suggest a new feature
+labels: ['triage']
+body:
+    - type: textarea
+      id: feature
+      attributes:
+          label: What would you like to be added?
+      validations:
+          required: true
+
+    - type: textarea
+      id: rationale
+      attributes:
+          label: Why is this needed?
+      validations:
+          required: true

.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: Node.js CI
+
+on:
+    push:
+        branches: [main]
+    pull_request:
+        branches: [main]
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/checkout@v3
+            - name: Use Node.js
+              uses: actions/setup-node@v3
+              with:
+                  node-version: '18.x'
+
+            - name: Install dependencies
+              run: npm install
+            - name: Build plugin
+              run: npm run build
+            - name: Lint plugin (ESLint)
+              run: npm run lint

README-ZH.md

@@ -0,0 +1,3 @@
+# Obsidian Typewriter Sounds
+
+Simulates typewriter sounds in Obsidian.md

README.md

@@ -1,104 +1,8 @@
-# Obsidian Sample Plugin
+# Obsidian Typewriter Sounds
 
-This is a sample plugin for Obsidian (<https://obsidian.md>).
+source: <https://forum.obsidian.md/t/typewriter-sounds/15474>
+先行者：<https://github.com/adityaketkar/obsidian-typewriter-sounds>
 
-This project uses Typescript to provide type checking and documentation.
-The repo depends on the latest plugin API (obsidian.d.ts) in Typescript Definition format, which contains TSDoc comments describing what it does.
+其他编辑器的拓展: <https://github.com/rbanffy/selectric-mode/blob/master/selectric-mode.el>
 
-**Note:** The Obsidian API is still in early alpha and is subject to change at any time!
-
-This sample plugin demonstrates some of the basic functionality the plugin API can do.
-
-- Adds a ribbon icon, which shows a Notice when clicked.
-- Adds a command "Open Sample Modal" which opens a Modal.
-- Adds a plugin setting tab to the settings page.
-- Registers a global click event and output 'click' to the console.
-- Registers a global interval which logs 'setInterval' to the console.
-
-## First time developing plugins?
-
-Quick starting guide for new plugin devs:
-
-- Check if [someone already developed a plugin for what you want](https://obsidian.md/plugins)! There might be an existing plugin similar enough that you can partner up with.
-- Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it).
-- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder.
-- Install NodeJS, then run `npm i` in the command line under your repo folder.
-- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`.
-- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`.
-- Reload Obsidian to load the new version of your plugin.
-- Enable plugin in settings window.
-- For updates to the Obsidian API run `npm update` in the command line under your repo folder.
-
-## Releasing new releases
-
-- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release.
-- Update your `versions.json` file with `"new-plugin-version": "minimum-obsidian-version"` so older versions of Obsidian can download an older version of your plugin that's compatible.
-- Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix `v`. See here for an example: <https://github.com/obsidianmd/obsidian-sample-plugin/releases>
-- Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release.
-- Publish the release.
-
-> You can simplify the version bump process by running `npm version patch`, `npm version minor` or `npm version major` after updating `minAppVersion` manually in `manifest.json`.
-> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json`
-
-## Adding your plugin to the community plugin list
-
-- Check <https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md>
-- Publish an initial version.
-- Make sure you have a `README.md` file in the root of your repo.
-- Make a pull request at <https://github.com/obsidianmd/obsidian-releases> to add your plugin.
-
-## How to use
-
-- Clone this repo.
-- Make sure your NodeJS is at least v16 (`node --version`).
-- `npm i` or `yarn` to install dependencies.
-- `npm run dev` to start compilation in watch mode.
-
-## Manually installing the plugin
-
-- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
-
-## Improve code quality with eslint (optional)
-
-- [ESLint](https://eslint.org/) is a tool that analyzes your code to quickly find problems. You can run ESLint against your plugin to find common bugs and ways to improve your code.
-- To use eslint with this project, make sure to install eslint from terminal:
-  - `npm install -g eslint`
-- To use eslint to analyze this project use this command:
-  - `eslint main.ts`
-  - eslint will then create a report with suggestions for code improvement by file and line number.
-- If your source code is in a folder, such as `src`, you can use eslint with this command to analyze all files in that folder:
-  - `eslint .\src\`
-
-## Funding URL
-
-You can include funding URLs where people who use your plugin can financially support it.
-
-The simple way is to set the `fundingUrl` field to your link in your `manifest.json` file:
-
-```json
-{
-    "fundingUrl": "https://buymeacoffee.com"
-}
-```
-
-If you have multiple URLs, you can also do:
-
-```json
-{
-    "fundingUrl": {
-        "Buy Me a Coffee": "https://buymeacoffee.com",
-        "GitHub Sponsor": "https://github.com/sponsors",
-        "Patreon": "https://www.patreon.com/"
-    }
-}
-```
-
-## API Documentation
-
-See <https://github.com/obsidianmd/obsidian-api>
-
-## Appreciation
-
-abc.js playback
-forum for idea
-and resource
+- fill package.json

manifest.json

@@ -1,9 +1,9 @@
 {
-	"id": "typewriter-sound",
-	"name": "Typewriter Sound",
-	"version": "developer",
-	"minAppVersion": "0.15.0",
-	"description": "This is a sample plugin for Obsidian. This plugin demonstrates some of the capabilities of the Obsidian API.",
+	"id": "typewriter-sounds",
+	"name": "Typewriter Sounds",
+	"version": "0.0.1",
+	"minAppVersion": "1.0.0",
+	"description": "Simulates typewriter sounds in Obsidian.md",
 	"author": "Acylation",
 	"authorUrl": "https://github.com/Acylation",
 	"isDesktopOnly": false

package.json

@@ -1,18 +1,19 @@
 {
-	"name": "typewriter-sound",
-	"version": "developer",
-	"description": "This is a sample plugin for Obsidian (https://obsidian.md)",
+	"name": "typewriter-sounds",
+	"version": "0.0.1",
+	"description": "Simulates typewriter sounds in Obsidian.md",
 	"main": "main.js",
 	"scripts": {
 		"dev": "node esbuild.config.mjs",
 		"build": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
 		"version": "node version-bump.mjs && git add manifest.json versions.json"
 	},
 	"keywords": [
-		"to-fill",
+		"typewriter",
 		"obsidian",
 		"obsidian-plugin",
-		"obsidian-md"
+		"obsidian-md",
+		"obsidian-community"
 	],
 	"author": "Acylation",
 	"license": "MIT",

versions.json

@@ -1,3 +1,3 @@
 {
-	"1.0.0": "0.15.0"
-}
+	"0.0.1": "1.0.0"
+}