Commit Graph

46 Commits (0e42e4e193c65f0e9489e9cf871dbd58eba2b12e)

Author SHA1 Message Date
Tshepang Mbambo 27891cdc8d
misc doc fixes/improvements (#7282) 2 years ago
Rich Seymour 751da01303
Update install.md instructions regarding symlinks (#7231)
* Update install.md

Fixes `ln` command line bug that could hit users moving from packaged to source builds.

* Remove extra 'how to' command example
2 years ago
Martin Weinelt 61a89956e3
book: Mention Helix package in nixpkgs (#7064) 2 years ago
David Else 69332ae3b2
Add Flathub as third party repository (#6994) 2 years ago
David Else 83c307a66a
Improve and update the installation documentation (#6809) 2 years ago
Nico Bos 894c2b9edb
Add Windows install instructions using Winget (#6602) 2 years ago
Gautam Panchal 3da63fa481
Add instructions for installing via AppImage (#6368) 2 years ago
paul-scott ce1fb9e64c
Generalised to multiple runtime directories with priorities (#5411)
* Generalised to multiple runtime directories with priorities

This is an implementation for #3346.

Previously, one of the following runtime directories were used:

1. `$HELIX_RUNTIME`
2. sibling directory to `$CARGO_MANIFEST_DIR`
3. subdirectory of user config directory
4. subdirectory of path to helix executable

The first directory provided / found to exist in this order was used as a
root for all runtime file searches (grammars, themes, queries).

This change lowers the priority of `$HELIX_RUNTIME` so that the user
config runtime has higher priority. More significantly, all of these
directories are now searched for runtime files, enabling a user to override
default or system-level runtime files. If the same file name appears
in multiple runtime directories, the following priority is now used:

1. sibling directory to `$CARGO_MANIFEST_DIR`
2. subdirectory of user config directory
3. `$HELIX_RUNTIME`
4. subdirectory of path to helix executable

One exception to this rule is that a user can have a `themes`
directory directly in the user config directory that has higher piority
to `themes` directories in runtime directories. That behaviour has been
preserved.

As part of implementing this feature `theme::Loader` was simplified
and the cycle detection logic of the theme inheritance was improved to
cover more cases and to be more explicit.

* Removed AsRef usage to avoid binary growth

* Health displaying ;-separated runtime dirs

* Changed HELIX_RUNTIME build from src instructions

* Updated doc for more detail on runtime directories

* Improved health symlink printing and theme cycle errors

The health display of runtime symlinks now prints both ends of the
link.

Separate errors are given when theme file is not found and when the
only theme file found would form an inheritence cycle.

* Satisfied clippy on passing Path

* Clarified highest priority runtime directory purpose

* Further clarified multiple runtime details in book

Also gave markdown headings to subsections.

Fixed a error with table indentation not building
table that also appears present on master.

---------

Co-authored-by: Paul Scott <paul.scott@anu.edu.au>
Co-authored-by: Blaž Hrastnik <blaz@mxxn.io>
2 years ago
David Else 707457c632
Rewrite and refactor all documentation (#5534)
* Rewrite and refactor all documentation

* Rewrite and refactor the guides

* update runtime directory instructions for windows

* Update the Ubuntu 3rd party repo section with 22.10

* Merge from upstream

* Rewrite and refactor all documentation

* Apply suggestions from code review

Apply the suggestions that can be committed from the GitHub web interface.

Co-authored-by: Michael Davis <mcarsondavis@gmail.com>

* Add Windows themes folder

Co-authored-by: digidoor <37601466+digidoor@users.noreply.github.com>

* Apply the rest of the suggestions from the code review

* Revert "Apply the rest of the suggestions from the code review"

This reverts commit 498be1b7a1aec3ff567b95130148628beeef9b77.

* Revert "Merge branch 'rewrite-and-refactor-all-documentation' of github.com:David-Else/helix into rewrite-and-refactor-all-documentation"

This reverts commit 7c8404248ffef73b80b9051d5a4359c5bcfa5d1a, reversing
changes made to d932969cfc9fadda12a74cc01665919dee7152fb.

* Apply code review suggestions

* Changes after re-reading all documents

* Missed a full stop

* Code review suggestions and remove macOS and Windows specific sections

* Add OpenBSD to heading

* Add back macOS and Windows sections and further simplify and improve

* Change wording to nightly

* Remove README installation section and turn into a link

* Simplify building from source and follow code review suggestions

* Code review revisions

* Fix copy paste mistake

* Apply the latest code review suggestions

* More small code review items

* Change minor modes for code review

* Fix link and typos

* Add note that you need a c++ compiler to install the tree-sitter grammars

* Add pacman example

* Make sure all headings are lower case

* Revert to the original passage adding a reference to Windows that was missing

* Update book/src/guides/adding_languages.md

Fix grammar typo

Co-authored-by: Michael Davis <mcarsondavis@gmail.com>

* Update book/src/install.md

Fix tree sitter typo

Co-authored-by: Michael Davis <mcarsondavis@gmail.com>

* Remove TOC links to main heading

---------

Co-authored-by: CptPotato <3957610+CptPotato@users.noreply.github.com>
Co-authored-by: Michael Davis <mcarsondavis@gmail.com>
Co-authored-by: digidoor <37601466+digidoor@users.noreply.github.com>
2 years ago
Jaeho Choi 0eba0db4a0
docs: Fix PowerShell runtime linking command (#5822) 2 years ago
yashpalgoyal1304 edd0ba7f19
book: Link MSYS2 proper command page (#5601) 2 years ago
Pascal Kuthe 1b69c7b4af
doc: add build instructions for musl-libc (#5572) 2 years ago
Michal Melewski a39a2ce9a8
book: Recommend '--locked' for cargo installs (#5438) 2 years ago
Biswapriyo Nath 6ae092acce
book: Clarify install commands for msys2 in Windows (#5363) 2 years ago
Zhizhen He 0c30aeea5b
fix typo (#4656) 2 years ago
0xflotus 75d7e0555e
fix: small error (#4651) 2 years ago
Konstantin Podsvirov f41f28b662
Update windows install instructions (#4530) 2 years ago
Greg Troszak fbf8078611
Clarify use of `HELIX_RUNTIME` (#4382) 2 years ago
Alex 8c9bb23650
Update windows install instructions (#4351) 2 years ago
David 7af7dadd17
Add instructions for gnome desktop support using the `.desktop` file (#4165) 2 years ago
NotAgentBilly df1ed0a5fd
xcopy - assume destination is a directory (#3686) 2 years ago
Michael Davis e441b1c472
packaging: Point to homebrew-core instead of tap (#3513) 2 years ago
jdrst 598aa7c424
adds xcopy param to recursively copy runtime folder (#3378) 2 years ago
Timothy DeHerrera fefa4d8c59
nix flake: make the binary cache "just work" (#2999) 2 years ago
Amit Beka 6100b1ba08
book: add wiki links to the title page and install page (#3017)
Co-authored-by: amitbeka <--->
2 years ago
川田 恵氏 (Kawada Keishi a.k.a megumish) 244825b9e1
Add runtime `xcopy` command on powershell in docs (#2958) 2 years ago
nitish-17 b31788102e
mention the requirement of C++ compiler for building grammar in doc (#2592) 3 years ago
Robert Walter fba198c1e0
Add documentation for `hx --health` (#2357) 3 years ago
chunghha 3a398eec56
fix typos (#2304) 3 years ago
matan h 02426072cb
add table of OS/command for copy/symlink the runtime folder to the config (#2073)
* create table of OS and commands in the readme

* add link to wiki from health check (without color; just simple println)

* move the table from readme to docs and add link from the readme to docs

* drop copy on unix,and apply some style fixes from the conversations

* by mistake, I edit master insted of develop

* remove this file from pr

* Update README.md

Co-authored-by: Michael Davis <mcarsondavis@gmail.com>

* copy table to readme

Co-authored-by: Michael Davis <mcarsondavis@gmail.com>
3 years ago
Marcin Puc 924462edda
Add install instructions for Void Linux (#1911) 3 years ago
Michael Davis 7044d7d804 rename '--fetch/build-grammars' flags into '--grammar fetch/build'
The old flags were a bit long. --grammar is also aliased to -g to make
it even easier.
3 years ago
Michael Davis 8081e9f052 replace all submodule documentation with flags documentation 3 years ago
Michael Davis 227e0108e9
add workflow for pushing nix flake artifacts to Cachix (#1721)
* add workflow for pushing nix flake artifacts to Cachix

* add docs on using the cachix cache from nix

* remove submodule clone from cachix workflow

* remove flake check
3 years ago
Chetan Vardhan 3ef115d420
Add instructions for Fedora Linux (#1270)
* Add instructions for Fedora Linux

* Update README.md

* Update install.md
3 years ago
Nicholas Boyd Isacsson 6204c38556
Remove defunct helix-bin AUR link 3 years ago
Blaž Hrastnik 4cc562318a Improve docs, fix up a few highlight scopes 3 years ago
Blaž Hrastnik 0fdb626c2c Remove embed_runtime feature
It's no longer practical to maintain. Closes #451
3 years ago
Blaž Hrastnik 866b32b5d7 Add repology.org packaging status 4 years ago
Blaž Hrastnik 14db2cc68b
Add homebrew tap instructions again 4 years ago
Brian Dawn ae105812d6 Apply suggestions from code review
Co-authored-by: Ivan Tham <pickfire@riseup.net>
4 years ago
Brian Dawn 62d181de78 Provide a feature flag to be able to embed the runtime folder.
These changes provide a new feature flag "embed_runtime" that when
enabled and built in release mode will embed the runtime folder into the
resulting binary.
4 years ago
Blaž Hrastnik 67b1cd32c7 Update install notes 4 years ago
Blaž Hrastnik 1132c5122f Update mdbook styling, add link to AUR 4 years ago
Blaž Hrastnik bc99b61be2 Update the book (keymaps). 4 years ago
Blaž Hrastnik 16350399ac Add book/ (mdbook based user guide) 4 years ago