mirror of
https://github.com/cursorless-dev/cursorless.git
synced 2024-10-05 05:17:38 +03:00
Don't let the cursor slow you down
starred-cursorless-dev-repostarred-repostructure-editortalonvoicevoicevoice-codingvscodevscode-extension
d90a3698f1
* Inline documentation added for some key functions * Docusaurus minimal set up added * Fixed links to repository sub directories * Added contributing/api using TypeDoc * Updated publish docs workflow * Link hack docs, publish only on main branch * Update website/docusaurus.config.js More robust fixing relative link to repository artifacts Co-authored-by: Pokey Rule <755842+pokey@users.noreply.github.com> * Addressed review comments; Github workflow to test documentation build added * Update .github/workflows/deploy-docs.yml Co-authored-by: Pokey Rule <755842+pokey@users.noreply.github.com> * Update .github/workflows/deploy-docs.yml Deployment should be authored by cursor less bot Co-authored-by: Pokey Rule <755842+pokey@users.noreply.github.com> * Apply pull request suggestion * missing-exports plugging added * Moved contributing; Added new API index page * Avoid copying docs folder * Fix links to GitHub after docs folder move in previous commit * Fixed issue were relative links were rewritten to point to GitHub * Add stub contributing * Fix broken link to svg calculations * Add broken markdown link checker * Update tagline and run dock sours can fig through prettier * Disable markdown link checking in CHANGELOG.md * Factored out typedoc configuration from docusaurus * Prevents broken links like https://.../../ generated * Fixed link giving warning * Fixed typo * Better docusaurus config documentation * Serve folder with /docs/ subdir <- website/build for baseUrl to work correctly * Added CNAME to gh-pages root. Otherwise adhock commits when updated from GitHub Pages UI * Cleanup docs * Docs * More docs * Update docs-build.sh to clean out old artifacts Co-authored-by: Pokey Rule <755842+pokey@users.noreply.github.com> * runCommand fixed list numbering * Hide API index from the sidebar * Bumped docusaurus dependencies, minor nice improvements * Moved dogs build script to scripts folder * Edit launch configuration to debug docusaurus configuration * Use `www` as default * Switch to www * Fix ci * Trigger notification Co-authored-by: Pokey Rule <755842+pokey@users.noreply.github.com> |
||
|---|---|---|
| .github | ||
| .vscode | ||
| cursorless-snippets | ||
| cursorless-talon | ||
| data/playground | ||
| docs | ||
| gh-pages-root | ||
| images | ||
| schemas | ||
| scripts | ||
| src | ||
| website | ||
| .eslintrc.json | ||
| .gitignore | ||
| .vscodeignore | ||
| .yarnrc | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| NOTICE.md | ||
| package.json | ||
| README.md | ||
| third-party-licenses.csv | ||
| tsconfig.json | ||
| vsc-extension-quickstart.md | ||
| yarn.lock | ||
Welcome to Cursorless!
Cursorless is a spoken language for structural code editing, enabling developers to code by voice at speeds not possible with a keyboard. Cursorless decorates every token on the screen and defines a spoken language for rapid, high-level semantic manipulation of structured text.
Checkout the docs and videos to learn more. See installation.md for installation instructions.
And I heard you like GIFs?
Installation
Currently depends on Talon, though a keyboard version is planned.
See installation.md for installation instructions.
Extension Settings
This extension contributes the following settings:
cursorless.showOnStart: Whether decorations should appear on workspace startcursorless.hatSizeAdjustment: Percentage to increase or decrease hat size; positive increases sizecursorless.hatVerticalOffset: How much to vertically shift the hats as a percentage of font size; positive is upcursorless.hatEnablement.colors: Whether to enable particular hat colors.cursorless.hatEnablement.shapes: Whether to enable particular hat shapes.cursorless.hatPenalties.colors: How much to penalize each hat color. You will probably want to set this one to the number of syllables in the given style. Cursorless will then sort every style combination by number of syllables to refer to it.cursorless.hatPenalties.shapes: How much to penalize each hat shape. You will probably want to set this one to the number of syllables in the given style. Cursorless will then sort every style combination by number of syllables to refer to it.
Known Issues
- Cursorless calculates the position of the hats based on the characteristics of your font. If you find that the hats are off center you can try running this command:
cursorless.recomputeDecorationStyles
Change Log
See CHANGELOG.md.
Contributing
See CONTRIBUTING.md.
Attributions
See NOTICE.md.