From 3abe8a1103c8f27ec744a0c982ed93bc6c30f29c Mon Sep 17 00:00:00 2001 From: Julien Neuhart Date: Wed, 20 Nov 2019 11:43:51 +0100 Subject: [PATCH] improving documentation about documentation generation --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- README.md | 6 ++++-- build/docs/content/15-links.md | 6 ++++-- docs/index.html | 13 ++++++++----- docs/theme/gotenberg/views/index.html | 5 +++-- 5 files changed, 20 insertions(+), 12 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b758496e..e768c49b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -40,6 +40,6 @@ Fixes # - [ ] Have you lint your code locally prior to submission (`make lint`)? - [ ] Have you written new tests for your core changes, as applicable? - [ ] Have you successfully ran tests with your changes locally (`make tests`)? -- [ ] Have you updated the documentation (`make doc`)? +- [ ] Have you updated the documentation (Markdown files under `build > docs > content` and then `make doc`)? - [ ] I have squashed any insignificant commits - [ ] This change has comments for package types, values, functions, and non-obvious lines of code diff --git a/README.md b/README.md index 68d014a3..d5ec5ddd 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

- Gotenberg logo + Gotenberg logo

Gotenberg

A Docker-powered stateless API for converting HTML, Markdown and Office documents to PDF.

@@ -39,4 +39,6 @@ to learn how to interact with it! --- -Psst: TheCodingMachine is always looking for [talented coders](https://coders.thecodingmachine.com). +

+ Gotenberg logo +

diff --git a/build/docs/content/15-links.md b/build/docs/content/15-links.md index 23ac7d55..17f2aa7c 100644 --- a/build/docs/content/15-links.md +++ b/build/docs/content/15-links.md @@ -2,8 +2,10 @@ title: Links --- +

+ Gotenberg logo +

+ * Follow the progress on the [GitHub repository](https://github.com/thecodingmachine/gotenberg) * Follow [@gulnap](https://twitter.com/gulnap) on Twitter * Thanks to [@mafredri](https://github.com/mafredri) for its help and its wonderful [cdp](https://github.com/mafredri/cdp) library - -Psst: TheCodingMachine is always looking for [talented coders](https://coders.thecodingmachine.com). diff --git a/docs/index.html b/docs/index.html index f96d7d0c..6df14916 100755 --- a/docs/index.html +++ b/docs/index.html @@ -32,7 +32,7 @@
- Gotenberg logo + Gotenberg logo Gotenberg A Docker-powered stateless API for converting HTML, Markdown and Office documents to PDF.
@@ -1504,17 +1504,20 @@ restart your Gotenberg instances from time to time to ensure a nominal behaviour

Links

-
-
+
+
diff --git a/docs/theme/gotenberg/views/index.html b/docs/theme/gotenberg/views/index.html index 0350c3ae..aa43f10f 100644 --- a/docs/theme/gotenberg/views/index.html +++ b/docs/theme/gotenberg/views/index.html @@ -34,7 +34,7 @@
- Gotenberg logo + Gotenberg logo {{.Title}} {{.Subtitle}}
@@ -58,7 +58,8 @@ {{.Content}}
{{end}} -
+
+