Skip to content

Commit

Permalink
Add related software documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
twpayne committed Apr 23, 2021
1 parent bdab05d commit 546070b
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,8 @@ Read what [people have said about chezmoi](docs/MEDIA.md).
of chezmoi.
* [Reference](docs/REFERENCE.md) for a complete description of chezmoi.
* [Comparison guide](docs/COMPARISON.md) for a comparison with other dotfile managers.
* [Related software](docs/RELATED.md) for third party software that works with
chezmoi.
* [Contributing](docs/CONTRIBUTING.md) for people looking to contribute to or
package chezmoi.

Expand Down
4 changes: 4 additions & 0 deletions chezmoi.io/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ content-docs: \
content/docs/media.md \
content/docs/quick-start.md \
content/docs/reference.md \
content/docs/related.md \
content/docs/templating.md

content/docs/changes.md: ../docs/CHANGES.md ../internal/cmd/generate-chezmoi.io-content-docs/main.go Makefile
Expand Down Expand Up @@ -42,5 +43,8 @@ content/docs/quick-start.md: ../docs/QUICKSTART.md ../internal/cmd/generate-chez
content/docs/reference.md: ../docs/REFERENCE.md ../internal/cmd/generate-chezmoi.io-content-docs/main.go Makefile
go run ../internal/cmd/generate-chezmoi.io-content-docs -shorttitle="Reference" -longtitle="Reference Manual" < $< > $@ || ( rm -f $@ ; false )

content/docs/related.md: ../docs/RELATED.md ../internal/cmd/generate-chezmoi.io-content-docs/main.go Makefile
go run ../internal/cmd/generate-chezmoi.io-content-docs -shorttitle="Related" -longtitle="Related Software" < $< > $@ || ( rm -f $@ ; false )

content/docs/templating.md: ../docs/TEMPLATING.md ../internal/cmd/generate-chezmoi.io-content-docs/main.go Makefile
go run ../internal/cmd/generate-chezmoi.io-content-docs -shorttitle="Templating" -longtitle="Templating Guide" < $< > $@ || ( rm -f $@ ; false )
2 changes: 2 additions & 0 deletions chezmoi.io/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,8 @@ Read what [people have said about chezmoi](/docs/media/).
chezmoi.
* [Reference](/docs/reference/) for a complete description of chezmoi.
* [Comparison guide](/docs/comparison/) for a comparison with other dotfile managers.
* [Related software](/docs/related/) for third party software that works with
chezmoi.
* [Contributing](/docs/contributing/) for people looking to contribute to or
package chezmoi.

Expand Down
1 change: 1 addition & 0 deletions chezmoi.io/content/docs/menu/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,5 @@ headless = true
- [Media]({{< relref "/docs/media.md" >}})
- [Comparison]({{< relref "/docs/comparison.md" >}})
- [Contributing]({{< relref "/docs/contributing.md" >}})
- [Related Software]({{< relref "/docs/related.md" >}})
- [GitHub](https://github.com/twpayne/chezmoi)
16 changes: 16 additions & 0 deletions docs/RELATED.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# chezmoi Related software

<!--- toc --->

## [`github.com/alker0/chezmoi.vim`](https://github.com/alker0/chezmoi.vim)

Intelligent VIM syntax highlighting when editing files in your source directory.
Works with both `chezmoi edit` and editing files directly.

## [`github.com/tuh8888/chezmoi.el`](https://github.com/tuh8888/chezmoi.el)

Convenience functions for interacting with chezmoi in Emacs.

## [`github.com/Lilja/vim-chezmoi`](https://github.com/Lilja/vim-chezmoi)

A plugin for VIM to apply the dotfile you are editing on `:w`.

0 comments on commit 546070b

Please sign in to comment.