7
7
8
8
## Why DoCat?
9
9
10
- When generating static developer documentation using
10
+ When generating static documentation using
11
11
[ mkdocs] ( https://www.mkdocs.org/ ) , [ sphinx] ( http://www.sphinx-doc.org/en/master/ ) , ...
12
12
hosting just one version of the docs might not be enough.
13
13
Many users might still use older versions and might need to read
14
14
those versions of the documentation.
15
15
16
- Docat solves this problem by providing a simple tool that can
17
- host multiple documentation projects with multiple versions.
16
+ Docat solves this problem by providing a simple tool that
17
+ hosts multiple documentation projects with multiple versions.
18
18
19
- * The main design decision with docat was to keep the tool as simpel as possible*
19
+ * The main design decision with docat was to keep the tool as simple as possible. *
20
20
21
21
## Getting started
22
22
@@ -40,19 +40,21 @@ Go to [localhost:8000](http://localhost:8000) to view your docat instance:
40
40
41
41
### Using DoCat
42
42
43
- > 🛈 Please note that docat does not provide any way to write documentation
44
- > the tool only hosts documentation.
43
+ > 🛈 Please note that docat does not provide any way to write documentation.
44
+ > It's sole responsibility is to host documentation.
45
45
>
46
- > There are many awesome tools to write developer documenation:
47
- > [ mkdocs] ( https://www.mkdocs.org/ ) , [ sphinx] ( http://www.sphinx-doc.org/en/master/ ) ,
48
- > [ mdbook] ( https://rust-lang.github.io/mdBook/ ) ...
46
+ > There are many awesome tools to write documenation:
47
+ > - [ mkdocs] ( https://www.mkdocs.org/ )
48
+ > - [ sphinx] ( http://www.sphinx-doc.org/en/master/ )
49
+ > - [ mdbook] ( https://rust-lang.github.io/mdBook/ )
50
+ > - ...
49
51
50
52
51
- A small tool called [ docatl] ( https://github.com/docat-org/docatl ) is provided
53
+ A CLI tool called [ docatl] ( https://github.com/docat-org/docatl ) is available
52
54
for easy interaction with the docat server.
53
55
However, interacting with docat can also be done through [ ` curl ` ] ( doc/getting-started.md ) .
54
56
55
- So in order to push documentation (and tag as ` latest ` ) in the folder ` docs/ ` simply run:
57
+ To push documentation (and tag as ` latest ` ) in the folder ` docs/ ` simply run:
56
58
57
59
``` sh
58
60
docatl push --host http://localhost:8000 ./docs PROJECT VERSION --tag latest
0 commit comments