https://github.com/chenyukang/obsidian-speech

https://github.com/chenyukang/obsidian-speech

Last synced: 22 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/chenyukang/obsidian-speech
• Owner: chenyukang
• License: mit
• Created: 2022-07-09T10:25:48.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-07-27T16:44:50.000Z (over 2 years ago)
• Last Synced: 2024-08-07T23:48:40.182Z (3 months ago)
• Language: TypeScript
• Size: 51.8 KB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• my-awesome - chenyukang/obsidian-speech - 07 star:0.0k fork:0.0k (TypeScript)

README

        
# Obsidian Speech Plugin

If you want to do your best on writing, you should read your writing out loud.

- You will find your voice.

- You will find mistakes and unnecessary words and sentences.

- You will make your writing easy for reading.

This is a simple [Obsidian](https://obsidian.md) plugin to read your content.

## How to use

- Clone this repo.

- `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\`

## API Documentation

See https://github.com/obsidianmd/obsidian-api