Skip to content

Commit

Permalink
Update documents
Browse files Browse the repository at this point in the history
  • Loading branch information
tamada committed Jul 2, 2019
1 parent efd8c0b commit 98acb51
Show file tree
Hide file tree
Showing 7 changed files with 51 additions and 2 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -644,6 +644,13 @@ However, the means of `grim` is not good, and there are many commands which star
Therefore, we changed the project name to RRH.
RRH means "Repositories, Ready to Hack," is not the abbreviation of the Red Riding Hood.
### Attributions
#### Icon of RRH
![icon of rrh](https://raw.githubusercontent.com/tamada/rrh/master/docs/static/favicon-64x64.png) by [iconpon.com](https://www.iconpon.com/)
## Table of Contents
* [Description](#description)
Expand Down Expand Up @@ -684,3 +691,4 @@ RRH means "Repositories, Ready to Hack," is not the abbreviation of the Red Ridi
* [Discussion](#discussion)
* [Author](#author)
* [Why the project name RRH?](#why-the-project-name-rrh)
* [Attributions](#attributions)
13 changes: 13 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
PWD := ${CURDIR}
DOCKER_IMAGE_NAME := "wwwrrh"
CONTAINER_REMOVE_FLAG := "--rm"

start:
docker run ${CONTAINER_REMOVE_FLAG} -d --name ${DOCKER_IMAGE_NAME} -p 1313:1313 -v "${PWD}":/src -v "$(PWD)"/public:/output -e HUGO_THEME=cayman-hugo-theme -e HUGO_WATCH="true" jojomi/hugo:latest

stop:
docker stop wwwrrh

build:
echo $(PWD)
docker run ${CONTAINER_REMOVE_FLAG} -d --name ${DOCKER_IMAGE_NAME} -p 1313:1313 -v "${PWD}":/src -v ${PWD}/public:/output -e HUGO_THEME=cayman-hugo-theme jojomi/hugo:latest
14 changes: 14 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Web page of rrh

## To start local page

```
$ make start # <- start local server
$ make stop # <- stop local server
$ make build # <- build web page to public dir
```

## Requirements

* Docker

5 changes: 3 additions & 2 deletions docs/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,9 @@ RRH is a simple git repository manager.
* [`rrhpeco`](utilities#rrhpeco)
* [About the Project](about)
* [Contribution](about#contribution)
* [Discussion](about#disucussion)
* [Why the project name RRH](about#why-the-project-name-rrh)
* [Code of Conduct](about#code-of-conduct)
* [License](about#license)
* [Discussion](about#disucussion)
* [Authors](about#authors)
* [Why the project name RRH](about#why-the-project-name-rrh)
* [Attributions](about#attributions)
6 changes: 6 additions & 0 deletions docs/content/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,9 @@ At first, the name of this project was GRIM (Git Repository Integrated Manager).
However, the means of `grim` is not good, and there are many commands which start with `gr`.
Therefore, we changed the project name to `rrh`.
RRH means "Repositories, Ready to Hack," is not the abbreviation of the Red Riding Hood.

### Attributions

#### Icon of RRH

{{< figure src="/rrh/images/logo.png" width="64" >}} by [iconpon.com](https://www.iconpon.com/)
7 changes: 7 additions & 0 deletions docs/layouts/shortcodes/figure.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{{ $path := .Get "src" }}
{{ $width := .Get "width" }}
<img src="{{ $path }}"
{{ if $width }}
width="{{ $width }}"
{{ end }}
/>
Binary file added docs/static/favicon-64x64.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 98acb51

Please sign in to comment.