{"id":13672769,"url":"https://github.com/acheronfail/xi-electron","last_synced_at":"2025-10-05T13:44:14.958Z","repository":{"id":118822745,"uuid":"89203380","full_name":"acheronfail/xi-electron","owner":"acheronfail","description":"A front-end for the xi-editor built with modern web technologies.","archived":false,"fork":false,"pushed_at":"2019-04-25T16:03:37.000Z","size":4409,"stargazers_count":345,"open_issues_count":6,"forks_count":24,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-04-28T03:34:22.204Z","etag":null,"topics":["canvas","electron","electron-forge","webgl","xi-editor","xi-electron"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/acheronfail.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2017-04-24T06:03:11.000Z","updated_at":"2025-01-09T20:12:52.000Z","dependencies_parsed_at":null,"dependency_job_id":"256258a3-04a6-450e-b71a-3955849d66df","html_url":"https://github.com/acheronfail/xi-electron","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/acheronfail/xi-electron","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acheronfail%2Fxi-electron","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acheronfail%2Fxi-electron/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acheronfail%2Fxi-electron/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acheronfail%2Fxi-electron/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/acheronfail","download_url":"https://codeload.github.com/acheronfail/xi-electron/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acheronfail%2Fxi-electron/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278464315,"owners_count":25991177,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-05T02:00:06.059Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["canvas","electron","electron-forge","webgl","xi-editor","xi-electron"],"created_at":"2024-08-02T09:01:47.206Z","updated_at":"2025-10-05T13:44:14.921Z","avatar_url":"https://github.com/acheronfail.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# Xi Electron\n\n_A front-end for the xi-editor built with modern web technologies._\n\n[![Build Status](https://travis-ci.org/acheronfail/xi-electron.svg?branch=master)](https://travis-ci.org/acheronfail/xi-electron)\n\nNOTE: This is still a WIP!\n\n## Demo\n\n![canvas renderer](./doc/canvas.png)\n\n## Goals of this Repo\n\n* Make a front-end for [`xi-editor`](https://github.com/google/xi-editor) that is consistent across platforms\n* Experiment with different editor rendering techniques on the web, specifically:\n    - `2d` - `\u003ccanvas\u003e`\n    - `DOM` - direct use of the DOM (have a look at how [CodeMirror](http://marijnhaverbeke.nl/blog/a-pathological-scrolling-model.html) tackled some of the challenges of using the DOM)\n    - `WebGL` - GPU accelerated rendering (via `\u003ccanvas\u003e`)\n* Hopefully create a functional mobile friendly version that is also fast and pleasant to use\n    - once all three views are implemented we can benchmark them against each other\n\nThe main motivation for this repo is to experiment and profile the speeds and performance of different rendering techniques for text editors in the browser, specifically with modern HTML5 APIs and the like. The final goal would be a fully cross-platform (desktop+mobile) text editing experience, but that's still a long hope at this stage.\n\n## Getting started\n\nTo build and run `xi-electron` you'll need to have [NodeJS](https://nodejs.org) installed (Node version 6 or greater) as well as `Git`.\n\nTo get started:\n\n```bash\n\u003e git clone https://github.com/acheronfail/xi-electron --recursive\n\u003e cd xi-electron\n\u003e yarn            # or: npm install\n\n# Build xi-core:\n\u003e yarn core:build\n\n# If you just want to run in dev mode then run:\n\u003e yarn start      # or: npm run start\n\n# To build xi-electron into an application:\n\u003e yarn make       # or: npm run make\n```\n\nThe `yarn build:core` script will attempt to build `xi-editor`, so you'll need Rust (see below for details).\nThe built app will be output to `xi-electron/out/`.\n\n## Building `xi-core`\n\nKeep in mind you'll need [Rust](https://www.rust-lang.org/) (version 1.30+ is recommended at the moment). On macOS platforms you'll need [Xcode 8.2](https://developer.apple.com/xcode/) and other relevant build tools.\n\nYou can build and install xi-core via `yarn build:core`. You can re-run this script anytime you like. [`xi-editor`](https://github.com/google/xi-editor) is currently placed in this repository as a submodule, so we can have a \"somewhat\" stable experience.\n\nIf you run into build issues ensure the submodule is present, ie:\n\n```bash\n\u003e git submodule update --init\n```\n\nAlternatively, if you'd like to clean and re-build everything again, you can run:\n\n```bash\n# Deletes all build artefacts:\n\u003e yarn core:clean\n# Rebuilds the core:\n\u003e yarn core:build\n```\n\nIf you'd like to build and use a more recent version of `xi-editor` then just place it under `src/xi-core`. For building `xi-editor` manually [refer to its instructions](https://github.com/google/xi-editor#building-the-core).\n\n## Contributing\n\nPlease! 🙏\n\n## Credits\n\n* All credits for the [xi-editor](https://github.com/google/xi-editor) go to Raph Levien.\n\n## License\n\n[MIT](LICENSE)\n\n\u003c!--\n\n# TODO for `xi-electron`\n\n- [ ] figure out how to build small xi-core/xi-syntect-plugin libs - currently they're quite large\n- [ ] re-factor to be more platform portable (hopefully generate nice libs for non-electron platforms)\n- [ ] implement WebGLView\n\n--\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facheronfail%2Fxi-electron","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Facheronfail%2Fxi-electron","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facheronfail%2Fxi-electron/lists"}