mirror of
https://github.com/cursorless-dev/cursorless.git
synced 2024-10-05 05:17:38 +03:00
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>
14 lines
155 B
Plaintext
14 lines
155 B
Plaintext
out
|
|
dist
|
|
node_modules
|
|
.vscode-test/
|
|
*.vsix
|
|
package-lock.json
|
|
*.DS_Store
|
|
|
|
# TypeDoc output
|
|
docs/contributing/api/
|
|
|
|
# Generated docs hub
|
|
gh-pages-root/docs/
|