tldr/Makefile

index:
	@TLDRHOME=`pwd` ./scripts/build_index.rb
	@echo "Index rebuilt."

setup:
	@cp ./scripts/pre-commit .git/hooks
	@chmod +x .git/hooks/pre-commit
	@echo "Git pre-commit hook installed."
	
	@gem install mdl --install-dir .gem --no-rdoc --no-ri
	@echo "Installed required Ruby gems under .gem"
	
lint: 
	@GEM_PATH=.gem find pages -exec .gem/bin/mdl {} --style ./scripts/markdown-style.rb 1>&2 \;
	
lint-changed:
	@./scripts/lint-changed.sh
feature: pages index. By having an index for the pages, it'd allow clients to build autocomplete's and show an index of pages making only one request (think `tldr list`). Subsequent caching of this file would prevent further requests. Included is a makefile to easily rebuild the index. It could be tailored in case the pages structure changed. In a particular case, the web client would benefit greatly from an index. It'd know exactly what folder a command is in and thus the number of requests would drop from 4 to 1. 2015-03-02 18:21:27 +00:00			`index:`
refactors index building script to output JSON also removes index.md 2015-03-05 00:10:08 +00:00			@TLDRHOME=`pwd` ./scripts/build_index.rb
feature: pages index. By having an index for the pages, it'd allow clients to build autocomplete's and show an index of pages making only one request (think `tldr list`). Subsequent caching of this file would prevent further requests. Included is a makefile to easily rebuild the index. It could be tailored in case the pages structure changed. In a particular case, the web client would benefit greatly from an index. It'd know exactly what folder a command is in and thus the number of requests would drop from 4 to 1. 2015-03-02 18:21:27 +00:00			`@echo "Index rebuilt."`
Added `make setup` and a pre-commit hook to rebuild index. 2015-04-09 12:19:48 +01:00
			`setup:`
			`@cp ./scripts/pre-commit .git/hooks`
			`@chmod +x .git/hooks/pre-commit`
			`@echo "Git pre-commit hook installed."`
Setup now installs markdown-lint. Make lint lints. 2015-04-14 15:22:21 +01:00
Added make lint-changed which lints changed files only. 2015-04-14 21:15:00 +01:00			`@gem install mdl --install-dir .gem --no-rdoc --no-ri`
Setup now installs markdown-lint. Make lint lints. 2015-04-14 15:22:21 +01:00			`@echo "Installed required Ruby gems under .gem"`

			`lint:`
Added make lint-changed which lints changed files only. 2015-04-14 21:15:00 +01:00			`@GEM_PATH=.gem find pages -exec .gem/bin/mdl {} --style ./scripts/markdown-style.rb 1>&2 \;`

			`lint-changed:`
			`@./scripts/lint-changed.sh`