{"id":15612508,"url":"https://github.com/vjousse/vim-for-humans-book","last_synced_at":"2025-06-26T07:03:14.219Z","repository":{"id":23450537,"uuid":"26814278","full_name":"vjousse/vim-for-humans-book","owner":"vjousse","description":"The vim for humans book","archived":false,"fork":false,"pushed_at":"2024-06-14T09:45:37.000Z","size":23811,"stargazers_count":135,"open_issues_count":4,"forks_count":20,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-05-09T00:01:58.044Z","etag":null,"topics":["book","ebook","latex","vim"],"latest_commit_sha":null,"homepage":"https://vimebook.com","language":"TeX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"ucsb-seclab/ictf-framework","license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vjousse.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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-11-18T15:00:41.000Z","updated_at":"2025-04-01T13:06:10.000Z","dependencies_parsed_at":"2024-05-20T21:09:55.656Z","dependency_job_id":"cc3daed1-cd4f-4212-b3a2-5492b2ba9796","html_url":"https://github.com/vjousse/vim-for-humans-book","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/vjousse/vim-for-humans-book","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vjousse%2Fvim-for-humans-book","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vjousse%2Fvim-for-humans-book/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vjousse%2Fvim-for-humans-book/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vjousse%2Fvim-for-humans-book/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vjousse","download_url":"https://codeload.github.com/vjousse/vim-for-humans-book/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vjousse%2Fvim-for-humans-book/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262018677,"owners_count":23245618,"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","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":["book","ebook","latex","vim"],"created_at":"2024-10-03T06:43:16.760Z","updated_at":"2025-06-26T07:03:14.196Z","avatar_url":"https://github.com/vjousse.png","language":"TeX","funding_links":[],"categories":["Uncategorized"],"sub_categories":["Uncategorized"],"readme":"# Vim for humans\n\nWebsite code available here: https://github.com/vjousse/vim-for-humans-website\n`vimrc` config examples available here: https://github.com/vjousse/vim-for-humans\n\n## Install\n\nBe sure to create a symlink named 'vim-for-humans' in the project directory. This symlink should point to a directory where you've cloned [code examples](https://github.com/vjousse/vim-for-humans).\n\nYou will need some prerequisites to be able to compile the LaTeX source code:\n\n- A Tex distribution, [TexLive](https://www.tug.org/texlive/) for example.\n- [Pygments](http://pygments.org/), it's used for syntax highlighting using the mint LaTeX package.\n- [Sphinx](http://sphinx-doc.org/) to generate the epub file.\n- [kindlegen](http://www.amazon.com/gp/feature.html?docId=1000765211) to generate the .mobi file.\n- [sphinx-autobuild](https://github.com/sphinx-doc/sphinx-autobuild) if you want to start a webserver with hot reload in `rst/fr` with `make livehtml`\n\n### Archlinux\n\n    yay -S python-sphinx python-pygments kindlegen\n\nUse [instructions from the official website for TeX Live](https://tug.org/texlive/quickinstall.html)\n\n## Compile\n\nAfter the dependencies have been installed, run `makedist.sh` script to start compiling. If the compilation fails, be sure to check the content of the script and try running each command one after another.\n\n## Enjoy\n\nUpon success outputs can be found in the `dist/vimpourleshumains/` directory. Enjoy!\n\n## Tips \u0026 tricks\n\n### Generate rounded/shadowed image\n\nBe sur to have [ImageMagick](https://imagemagick.org/index.php) installed and use the `add-borders.sh` script like these:\n\n    ./add-borders.sh book-tex/graphics/vim-catpuccin-mocha.png\n\nIt will replace your `book-tex/graphics/vim-catpuccin-mocha.png` image with a rounded/shadowed one and save the original image to `book-tex/graphics/vim-catpuccin-mocha-original.png`.\n\n### Get kitty terminal window for screenshots with sway\n\nWith sway, be sure that your [kitty](https://sw.kovidgoyal.net/kitty/) window is floating. Then resize it and change kitty font size.\n\n    swaymsg -r resize set width 1200 px; swaymsg -r resize set height 1000 px; kitty @ set-font-size 14\n\nFont used: FiraCode Nerd Font from [Nerd Fonts](https://www.nerdfonts.com/font-downloads).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvjousse%2Fvim-for-humans-book","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvjousse%2Fvim-for-humans-book","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvjousse%2Fvim-for-humans-book/lists"}