Skip to content

Commit 286fc02

Browse files
author
Erik Hofer
authored
Update README.md
1 parent cee10c2 commit 286fc02

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
11
# Code FREAK Documentation
22
[![](https://images.microbadger.com/badges/version/cfreak/homepage-docs.svg)](https://hub.docker.com/r/cfreak/homepage-docs)
33

4-
> :warning: **This is only the static site generator for docs.codefreak.org**: If you look for the actual content for [docs.codefreak.org](https://docs.codefreak.org) please head over to the [`/docs`](https://github.com/codefreak/codefreak/tree/master/docs) directory in our main repository.
4+
> :warning: **This is only the static site generator for docs.codefreak.org**. If you look for the actual content of [docs.codefreak.org](https://docs.codefreak.org) please head over to the [`/docs`](https://github.com/codefreak/codefreak/tree/master/docs) directory in our main repository.
55
66
This is our repository to convert [Code FREAK](https://codefreak.org)'s documentation to static HTML. We use [Antora](https://antora.org/) to covert AsciiDoc to an accessible HTML site and deploy it as Docker image.
77

88
## Editing
99
Editing of the page contents is done in the main repository's [`/docs` direcotry](https://github.com/codefreak/codefreak/tree/master/docs). This repository only contains the Antora configuration and some additional styling. Check out the official [Antora documentation](https://docs.antora.org/) to find out more about its internals.
1010

1111
## Installation
12-
You can either use Docker to build the static pages, or if you would like to create a manual build outside of Docker check out [Antora's installation guide](https://docs.antora.org/antora/2.0/install/install-antora/#install-antora-globally-using-npm).
12+
You can either use Docker to build the static pages, or if you would like to create a manual build outside of Docker, check out [Antora's installation guide](https://docs.antora.org/antora/2.0/install/install-antora/#install-antora-globally-using-npm).
1313

1414
## Build
15-
You can create a local build with Docker by using `docker build -t cfreak/homepage-docs .` inside the root direcoty of this repository. Afterwards you can start the container with `docker run --rm -it -p8080:80 cfreak/homepage-docs`.
15+
You can create a local build with Docker by using `docker build -t cfreak/homepage-docs .` inside the root direcoty of this repository. You can then start the container with `docker run --rm -it -p8080:80 cfreak/homepage-docs`.
1616

1717
## Deployment
18-
or image deployment we use Docker Hub's Autodeployment feature. It is connected to this repository. The official image is deployed as [`cfreak/homepage-docs`](https://hub.docker.com/r/cfreak/homepage-docs)
18+
For image deployment we use Docker Hub's auto-deployment feature. It is connected to this repository. The official image is deployed as [`cfreak/homepage-docs`](https://hub.docker.com/r/cfreak/homepage-docs)
19+
1920
## License
2021

2122
Code FREAK | Code Feedback Review & Evaluation Kit

0 commit comments

Comments
 (0)