Skip to content

Commit

Permalink
Closes #420
Browse files Browse the repository at this point in the history
  • Loading branch information
sobolevn committed Jun 26, 2021
1 parent b65673c commit d79b559
Show file tree
Hide file tree
Showing 8 changed files with 24 additions and 17 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -137,4 +137,5 @@ build/
docs/man
docs/_posts
docs/_includes/install-*.sh
docs/_includes/version.txt
CHANGELOG-RELEASE.md
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 4 additions & 0 deletions docs/Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down
13 changes: 3 additions & 10 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
4 changes: 3 additions & 1 deletion docs/_includes/header.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

<div class="wrapper">

<a class="site-title" href="{{ site.baseurl }}/">{{ site.title }}</a>
<a class="site-title" href="{{ site.baseurl }}/">
{{ site.title }} v{% include version.txt %}
</a>

<div class="site-nav">
<a href="#" class="menu-icon">
Expand Down
2 changes: 1 addition & 1 deletion docs/_includes/why.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
14 changes: 10 additions & 4 deletions docs/create_posts.sh → docs/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
---"
Expand All @@ -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
---"
Expand All @@ -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

0 comments on commit d79b559

Please sign in to comment.