diff --git a/.gitignore b/.gitignore index ce93a907..7ba5a906 100644 --- a/.gitignore +++ b/.gitignore @@ -137,4 +137,5 @@ build/ docs/man docs/_posts docs/_includes/install-*.sh +docs/_includes/version.txt CHANGELOG-RELEASE.md diff --git a/Makefile b/Makefile index 6b76c29d..f4a8e835 100644 --- a/Makefile +++ b/Makefile @@ -106,7 +106,7 @@ build-man: git-secret .PHONY: build-docs build-docs: build-man - ${SHELL} docs/create_posts.sh + ${SHELL} docs/build.sh .PHONY: docs docs: build-docs diff --git a/docs/Gemfile b/docs/Gemfile index 4f0b0f6b..9c80ac49 100644 --- a/docs/Gemfile +++ b/docs/Gemfile @@ -3,4 +3,5 @@ source "https://rubygems.org" group :jekyll_plugins do gem "jekyll", ">= 3.6.3" gem "jekyll-seo-tag", "~> 2.7.1" + gem "jekyll-environment-variables", ">= 1.0.1" end diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index f777997e..4bab3452 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -29,6 +29,8 @@ GEM rouge (~> 3.0) safe_yaml (~> 1.0) terminal-table (~> 2.0) + jekyll-environment-variables (1.0.1) + jekyll (>= 3.0, < 5.x) jekyll-sass-converter (2.1.0) sassc (> 2.0.1, < 3.0) jekyll-seo-tag (2.7.1) @@ -61,9 +63,11 @@ GEM PLATFORMS x86_64-linux + x86_64-linux-musl DEPENDENCIES jekyll (>= 3.6.3) + jekyll-environment-variables (>= 1.0.1) jekyll-seo-tag (~> 2.7.1) BUNDLED WITH diff --git a/docs/_config.yml b/docs/_config.yml index 08e49fc6..b874b7ac 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,15 +1,7 @@ -# Welcome to Jekyll! -# -# This config file is meant for settings that affect your whole blog, values -# which you are expected to set up once and rarely need to edit after that. -# For technical reasons, this file is *NOT* reloaded automatically when you use -# 'jekyll serve'. If you change this file, please restart the server process. - # Site settings title: git-secret email: mail@sobolevn.me -description: > # this means to ignore newlines until "baseurl:" - A bash-tool to store your private data inside a git repository. +description: A bash-tool to store your private data inside a git repository. baseurl: "" # the subpath of your site, e.g. /blog url: "git-secret.io" # the base hostname & protocol for your site @@ -20,8 +12,9 @@ github_plugins: "https://github.com/sobolevn/git-secret/wiki/Third-party-plugins github_using: "https://github.com/sobolevn/git-secret/wiki/Who-uses" # Seo settings: -gems: +plugins: - jekyll-seo-tag + - jekyll-environment-variables # Build settings markdown: kramdown diff --git a/docs/_includes/header.html b/docs/_includes/header.html index d43b9f61..e105212b 100644 --- a/docs/_includes/header.html +++ b/docs/_includes/header.html @@ -2,7 +2,9 @@
- {{ site.title }} + + {{ site.title }} v{% include version.txt %} +
diff --git a/docs/_includes/why.md b/docs/_includes/why.md index 8a9b33a8..6f0b3c29 100644 --- a/docs/_includes/why.md +++ b/docs/_includes/why.md @@ -15,4 +15,4 @@ There's a known problem in server configuration and deploying, when you have to `git-secret` is a bash tool to store your private data inside a `git` repo. How's that? Basically, it just encrypts, using `gpg`, the tracked files with the public keys of all the users that you trust. So everyone of them can decrypt these files using only their personal secret key. Why deal with all this private-public keys stuff? Well, to make it easier for everyone to manage access rights. There are no passwords that change. When someone is out - just delete their public key, reencrypt the files, and they won't be able to decrypt secrets anymore. -[![git-secret terminal preview](git-secret.gif)](https://asciinema.org/a/41811?autoplay=1) +[![git-secret terminal preview](https://raw.githubusercontent.com/sobolevn/git-secret/master/git-secret.gif)](https://asciinema.org/a/41811?autoplay=1) diff --git a/docs/create_posts.sh b/docs/build.sh similarity index 89% rename from docs/create_posts.sh rename to docs/build.sh index c5f70a4e..529a48bd 100644 --- a/docs/create_posts.sh +++ b/docs/build.sh @@ -34,8 +34,8 @@ function copy_to_posts { short_name=$(echo "$com" | sed -n "s|$MAN_LOCATION/\(.*\)\.1\.md|\1|p") local command_header="--- layout: post -title: '${short_name}' -date: ${timestamp} +title: '${short_name}' +date: ${timestamp} permalink: ${short_name} categories: command ---" @@ -48,8 +48,8 @@ categories: command # Creating main usage file: local usage_header="--- layout: post -title: 'git-secret' -date: ${timestamp} +title: 'git-secret' +date: ${timestamp} permalink: git-secret categories: usage ---" @@ -68,6 +68,12 @@ function copy_install_scripts { } +function copy_version { + echo "$(./git-secret --version)" > docs/_includes/version.txt +} + + checkout_manuals copy_to_posts copy_install_scripts +copy_version