use markdown for the documentation (#1474)

* add doc.md

* use h2 for doc sections

* use h3 for doc commands/options/vars

* use backticks instead of quotes in the doc

* merge multiple commands/options in the doc

* change header levels in the doc

* add man page sections to the doc

* remove extra spaces in headers in the doc

* add man and plain conversions of the doc

* update doc

* add missing flags to the doc

* replace the old documentation with the new one

* remove old doc files

* remove the doc instructions from CONTRIBUTING.md

* change the links to the doc

* shorten long links in the readme

CONTRIBUTING.md

@@ -49,14 +49,3 @@ Adding a new command usually requires the following steps:
 There are two files named `os.go` and `os_windows.go` for unix and windows specific code respectively.
 If you add something to either of these files but not the other, you probably break the build for the other platform.
 If your addition works the same in both platforms, your addition probably belongs to `main.go` instead.
-
-## Make changes to the documentation
-
-There are three files that contain the documentation in various formats:
-
-- `doc.go` is the source of the [online documentation](https://pkg.go.dev/github.com/gokcehan/lf)
-- `docstring.go` is used when running `lf -doc`
-- `lf.1` is a man page which is commonly available on Unix-like operating systems (`man lf`)
-
-You should only make changes to `doc.go`, the other files are automatically generated **and should not be edited manually**.
-Run `go fmt && go generate` to ensure that the code is formatted and files are generated correctly.

README.md

@@ -1,13 +1,13 @@
 # LF
 
 [Google Groups](https://groups.google.com/forum/#!forum/lf-fm)
+| [Doc](doc.md)
 | [Wiki](https://github.com/gokcehan/lf/wiki)
 | [#lf](https://web.libera.chat/#lf) (on Libera.Chat)
 | [#lf:matrix.org](https://matrix.to/#/#lf:matrix.org) (with IRC bridge)
 
 [![Go Build](https://github.com/gokcehan/lf/actions/workflows/go.yml/badge.svg)](https://github.com/gokcehan/lf/actions/workflows/go.yml)
 [![Go Report Card](https://goreportcard.com/badge/github.com/gokcehan/lf)](https://goreportcard.com/report/github.com/gokcehan/lf)
-[![Go Reference](https://pkg.go.dev/badge/github.com/gokcehan/lf.svg)](https://pkg.go.dev/github.com/gokcehan/lf)
 
 `lf` (as in "list files") is a terminal file manager written in Go with a heavy inspiration from ranger file manager.
 See [faq](https://github.com/gokcehan/lf/wiki/FAQ) for more information and [tutorial](https://github.com/gokcehan/lf/wiki/Tutorial) for a gentle introduction with screencasts.
@@ -24,7 +24,7 @@ See [faq](https://github.com/gokcehan/lf/wiki/FAQ) for more information and [tut
 - Server/client architecture and remote commands to manage multiple instances
 - Extendable and configurable with shell commands
 - Customizable keybindings (vi and readline defaults)
-- A reasonable set of other features (see the [documentation](https://pkg.go.dev/github.com/gokcehan/lf))
+- A reasonable set of other features (see the [documentation](doc.md))
 
 ## Non-Features
 
@@ -66,7 +66,7 @@ After the installation `lf` command should start the application in the current
 
 Run `lf -help` to see command line options.
 
-Run `lf -doc` to see the [documentation](https://pkg.go.dev/github.com/gokcehan/lf).
+Run `lf -doc` to see the [documentation](doc.md).
 
 See [etc](etc) directory to integrate `lf` to your shell and/or editor.
 Example configuration files along with example colors and icons files can also be found in this directory.