diff --git a/docs/built_with_doco.md b/docs/built_with_doco.md new file mode 100644 index 0000000..b46874f --- /dev/null +++ b/docs/built_with_doco.md @@ -0,0 +1,19 @@ + +--- +title: Built with Doco +index: 3 +description: A number of documentation sites built with Doco. +--- + +The following is a list of the documentation sites that have been built with Doco. + +⚠️ Important: If you know of a site that should be in the list. Please submit a pull request to the doco [GitHub repository](github.com/paganotoni/doco). + +## Retabler +[Retabler](https://retabler.com) is a platform that facilitates data importing processes within companies. It provides an embeddable data importing widget that can be used with your application's data models. + +## LeapKit +[LeapKit](https://leapkit.sh) is a Web framework to quickly get started building web applications in Go. It provides a set of tools and libraries to help you build web applications quickly. + +## Doco +This website was also built with Doco. I guess you know that 😅. diff --git a/docs/getting_started.md b/docs/getting_started.md index 1f54ae8..a99de52 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -7,7 +7,41 @@ description: Learn how to get started with Doco, from installation to initializi Doco is delivered as a self-contained binary, making its usage and integration straightforward. The first step in utilizing Doco's full potential is to install this binary, which enables access to all its features, from converting markdown files to integrating with continuous integration workflows. This binary-focused approach ensures a streamlined and efficient user experience. ## Installing -To install Doco you can do it with the go tool or download the binary from the releases page. +To install download the binary from the releases page. You can find the latest release [here](https://github.com/paganotoni/doco/releases). + +Below are some examples on how to download depending on your OS and architecture. + +### On Mac +```sh +$ curl -OL https://github.com/paganotoni/doco/releases/latest/doco_Darwin_arm64.tar.gz +$ tar -xvzf doco_Darwin_arm64.tar.gz +$ mv doco /usr/local/bin/doco +``` + +### On Linux +```sh +$ wget https://github.com/paganotoni/doco/releases/latest/doco_Linux_x86_64.tar.gz +$ tar -xvzf doco_Linux_x86_64.tar.gz +$ sudo mv doco /usr/local/bin/doco +``` + +Doco builds the following OSs and architectures on each release: + +- Darwin_arm64 +- Darwin_x86_64 +- Linux_arm64 +- Linux_armv6 +- Linux_armv7 +- Linux_i386 +- Linux_x86_64 +- Windows_arm64 +- Windows_armv6 +- Windows_armv7 +- Windows_i386 +- Windows_x86_64 + +### Installing from source +Alternatively you have Go installed in your system you can also use Go to install the Doco binary. ```go go install github.com/paganotoni/doco/cmd/doco@latest @@ -35,4 +69,4 @@ Once the folder is initialized you can run the following command to generate the doco serve ``` -This will generate the static website in the `public` folder. and serve it. You can see your docs site at [http://localhost:3000/](http://localhost:3000/). Once you're done you can stop the server with `ctrl+c`. \ No newline at end of file +This will generate the static website in the `public` folder. and serve it. You can see your docs site at [http://localhost:3000/](http://localhost:3000/). Once you're done you can stop the server with `ctrl+c`.