Skip to content

Commit

Permalink
Initial Commit
Browse files Browse the repository at this point in the history
  • Loading branch information
Denperidge committed Jan 23, 2023
0 parents commit da9c123
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
USERORORG=Denperidge-Redpencil
DOCS=../
24 changes: 24 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <https://unlicense.org>
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Divio-Docs-Repo
A template repository to host all your documentation, collected by [divio-docs-gen](https://github.com/Denperidge-Redpencil/divio-docs-gen)!

## Usage
Simply set the environment variables (through a .env file in this folder, or using your shell) and run `./run.sh`! It can be automated using GH Actions or crontab.
If you want to put the docs in this folder, make sure to set `DOCS=../`. Alternatively, you can use `DOCS=../docs/` to output in a subdirectory.
For more info on the environment variables or what values they should hold, view [divio-docs-gen](https://github.com/Denperidge-Redpencil/divio-docs-gen).

## License
The code in this repository has been released in the public domain through the [Unlicense](LICENSE).
5 changes: 5 additions & 0 deletions run.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
git clone https://github.com/Denperidge-Redpencil/divio-docs-gen.git
cp .env divio-docs-gen/
cd divio-docs-gen
python3 -m pip install -r requirements.txt
python3 app/index.py

0 comments on commit da9c123

Please sign in to comment.