shijimi-editor 0.4.2 → 0.4.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -3
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@ English | [日本語](README.ja.md)
|
|
|
4
4
|
|
|
5
5
|
An integrated development environment for the terminal (TUI). The screen is laid out like VS Code. For editing you can choose between Helix-style modal editing and modeless VS Code-style keys. The command is `shj`.
|
|
6
6
|
|
|
7
|
-
Manual (English, with a Japanese version): <https://shijimi-manual
|
|
7
|
+
Home page: <https://mm1995tk.github.io/shijimi-editor/> / Manual (English, with a Japanese version): <https://mm1995tk.github.io/shijimi-editor/manual/> (source in [`site/`](site/) and [`manual/`](manual/))
|
|
8
8
|
|
|
9
9
|
The UI is in English by default. To switch it to Japanese, set `ui-language = "ja"` in `config.toml` (see [UI language](#ui-language)).
|
|
10
10
|
|
|
@@ -387,9 +387,9 @@ When the first argument is `diff` / `exec` / `skill`, it is treated as a subcomm
|
|
|
387
387
|
|
|
388
388
|
> `shj open` and `shj status` were removed and replaced by the IDE integration (`openFile` / `getOpenEditors` / `getCurrentSelection`).
|
|
389
389
|
|
|
390
|
-
## Editing the manual
|
|
390
|
+
## Editing the manual and the home page
|
|
391
391
|
|
|
392
|
-
The manual is built from `manual/` with [MkDocs Material](https://squidfunk.github.io/mkdocs-material/). When you push to `main`, GitHub Actions publishes
|
|
392
|
+
The manual is built from `manual/` with [MkDocs Material](https://squidfunk.github.io/mkdocs-material/). The home page is the plain HTML in `site/`. When you push to `main`, GitHub Actions publishes both to GitHub Pages: the home page at the root and the manual under `/manual/`. To preview the manual locally, run:
|
|
393
393
|
|
|
394
394
|
```sh
|
|
395
395
|
pip install -r manual/requirements.txt
|
|
@@ -398,6 +398,8 @@ mkdocs serve --config-file manual/mkdocs.yml
|
|
|
398
398
|
|
|
399
399
|
The manual has an English page (`name.en.md`, the default) and a Japanese page (`name.ja.md`) for each page. When you change one, change the other too. `manual/check-translations.sh` checks that every page has both languages and the same structure, and CI runs it on pull requests (it also fails when only one language of a page changed; add `[skip-i18n-check]` to the pull request title to skip that part, for a typo fix for example).
|
|
400
400
|
|
|
401
|
+
The screenshots and the demo video of the home page (`site/images/`) are recorded with [vhs](https://github.com/charmbracelet/vhs). After a change to the screen, run `site/screenshots/record.sh` (it needs Nix) to record them again. The scenes are the tapes in `site/screenshots/tapes/`.
|
|
402
|
+
|
|
401
403
|
## License
|
|
402
404
|
|
|
403
405
|
[MIT](LICENSE)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "shijimi-editor",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.3",
|
|
4
4
|
"description": "VS Code-style terminal IDE with Helix keybindings",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"homepage": "https://github.com/mm1995tk/shijimi-editor",
|
|
@@ -19,9 +19,9 @@
|
|
|
19
19
|
"node": ">=18"
|
|
20
20
|
},
|
|
21
21
|
"optionalDependencies": {
|
|
22
|
-
"shijimi-editor-linux-x64": "0.4.
|
|
23
|
-
"shijimi-editor-linux-arm64": "0.4.
|
|
24
|
-
"shijimi-editor-darwin-x64": "0.4.
|
|
25
|
-
"shijimi-editor-darwin-arm64": "0.4.
|
|
22
|
+
"shijimi-editor-linux-x64": "0.4.3",
|
|
23
|
+
"shijimi-editor-linux-arm64": "0.4.3",
|
|
24
|
+
"shijimi-editor-darwin-x64": "0.4.3",
|
|
25
|
+
"shijimi-editor-darwin-arm64": "0.4.3"
|
|
26
26
|
}
|
|
27
27
|
}
|