Ver código fonte

Update README.md

Dennis Rodewyk 5 anos atrás
pai
commit
da661f4c74
1 arquivos alterados com 18 adições e 20 exclusões
  1. 18 20
      README.md

+ 18 - 20
README.md

@@ -1,29 +1,29 @@
-# hugo-encrypt
+## hugo-encrypt
 
 `hugo-encrypt` is a golang port of [Hugo Encryptor](https://github.com/Li4n0/hugo_encryptor)
 
 `hugo-encrypt` is a tool that encrpyts content in your [Hugo](https://gohugo.io) posts. It uses AES-256-GCM to encrypt the contents of your posts, and inserts the necessary javascript code into the encrypted posts that decrypts the content after the correntc passphrase has been entered.
 
-## Installation and Usage
+### Installation and Usage
 
 **Option A:** Build it
 
-Requirements: go 1.11+
+- Requirements: go 1.11+
 
-**Step 1:** Install `hugo-encrypt`.
+- **Step 1:** Install `hugo-encrypt`.
 
 		$ go get github.com/Izumiko/hugo-encrypt
 
-**Step 2:** Place `shortcodes/hugo-encrypt.html` in the shortcode directory of your blog:
+- **Step 2:** Place `shortcodes/hugo-encrypt.html` in the shortcode directory of your blog:
 
 		$ mkdir -p /path/to/your/blog/layouts/shortcodes
 		$ cp shortcodes/hugo-encrypt.html /path/to/your/blog/layouts/shortcodes/hugo-encrypt.html
 
-**Step 3:** Merge i18n translation files and/or add your own language.
+- **Step 3:** Merge i18n translation files and/or add your own language.
 
 		$ cp -r i18n /path/to/your/blog/
 
-**Step 4:** Use hugo-encrypt to encrypt content**
+- **Step 4:** Use hugo-encrypt to encrypt content**
 
 		$ export PATH=/path/to/hugo-encrypt/:$PATH
 		$ hugo
@@ -31,14 +31,14 @@ Requirements: go 1.11+
 
 **Option B:** Use docker
 
-Requirements: docker
+- Requirements: docker
 
-		$ hugo
+- 		$ hugo
 		$ docker run -it --rm \
 			-v /path/to/hugo/public:/data/site \
 			chaosbunker/hugo-encrypt hugo-encrypt -sitePath /data/site`
 
-## Setting a password and using the `{{< hugo-encrypt >}}` tag in your blog posts
+### Setting a password and using the `{{< hugo-encrypt >}}` tag in your blog posts
 
 **Option 1:** Setting the password in your blogs config file
 
@@ -75,11 +75,11 @@ This content will also be encrypted!
 
 After generating the site with `hugo` and running `hugo-encrypt` all the private posts in your `public` directory are encrypted and the site can be published.
 
-## Configuration
+### Configuration
 
 Although `hugo-encrypt` works right out of the box, there are a few things that can be customized.
 .
-### Language
+#### Language
 
 Use i18n to display content generated by `hugo-Encrypt` in the language of your choice by setting the following param in your config file. Make sure to set the Param `DefaultContentLanguage` and add the corresponding language file to the i18n folder.
 
@@ -88,7 +88,7 @@ Use i18n to display content generated by `hugo-Encrypt` in the language of your
 	DefaultContentLanguage = "en-us"
 ```
 
-### Password storage
+#### Password storage
 
 `hugo-encrypt` uses _localStorage_ by default. This means the passphrase is permanently stored in the browser. By adding the `hugoEncryptStorage` param in your blog's config file you can set the storage method to _sessionStorage_.
 
@@ -97,24 +97,22 @@ Use i18n to display content generated by `hugo-Encrypt` in the language of your
 	hugoEncryptStorage = "session" # or "local"
 ```
 
-* **localStorage**:
+**localStorage**:
 
 	Once a visitor entered the correct passphrase the authorization status will not expire. The visitor can read the article until the passphrase has been changed or the browser cache is cleared.
 
-* **sessionStorage**:
+**sessionStorage**:
 
 	Once a visitor entered the correct passphrase the authorization will expire after the browser is closed.
 
-## Attention
+### Attention
 
-* Remember to keep the source files of your encrypted posts private. Never push your blog directory into a public repository as the encryption happens after generating the html files with `hugo`.
+Remember to keep the source files of your encrypted posts private. Never push your blog directory into a public repository as the encryption happens after generating the html files with `hugo`.
 
-* Remember to run `hugo-encrypt` after generating your site with `hugo` to encrypt the posts you want to be passphrase-protected. You might want to use a shell script instead of `hugo` to take care of both steps:
+Remember to run `hugo-encrypt` after generating your site with `hugo` to encrypt the posts you want to be passphrase-protected. You might want to use a shell script instead of `hugo` to take care of both steps:
 
-	```bash
 	#!/bin/bash
 
 	hugo --cleanDestinationDir
 	hugo-encrypt
-	```