Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit d779b00

Browse files
committedApr 1, 2021
README.md: link to external formatting of user manual
Some people don't like htmlpreview.github.io. I once or twice saw a case where it appeared to be affected by load limits. Since external sites are making the manual available, and it's unlikely there are too many changes between the last release and the current manual, just link to it as an alternative for folks. Signed-off-by: Elijah Newren <[email protected]>
1 parent 1db2f69 commit d779b00

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed
 

‎Documentation/git-filter-repo.txt

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
// This file is NOT the documentation; it's the *source code* for it.
22
// Please follow the "user manual" link under
33
// https://github.com/newren/git-filter-repo#how-do-i-use-it
4-
// to access the actual documentation.
4+
// to access the actual documentation, or view another site that
5+
// has compiled versions available, such as:
6+
// https://www.mankier.com/1/git-filter-repo
57

68
git-filter-repo(1)
79
==================

‎README.md

+5
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,11 @@ section](https://htmlpreview.github.io/?https://github.com/newren/git-filter-rep
7373
commands](Documentation/converting-from-bfg-repo-cleaner.md#cheat-sheet-conversion-of-examples-from-bfg),
7474
which covers every example from the BFG website
7575

76+
External sites also have [alternative formats of the user
77+
manual](https://www.mankier.com/1/git-filter-repo) available, at least
78+
for the most recent release. This also may be beneficial if
79+
htmlpreview.github.io starts hitting load limits.
80+
7681
# Why filter-repo instead of other alternatives?
7782

7883
This was covered in more detail in a [Git Rev News article on

0 commit comments

Comments
 (0)
Please sign in to comment.