Skip to content

Commit

Permalink
Updated to docs.conf structure
Browse files Browse the repository at this point in the history
  • Loading branch information
Denperidge committed Jan 25, 2023
1 parent da9c123 commit 0d12c84
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 12 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
divio-docs-gen
docs.conf
tmp/
40 changes: 30 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,30 @@
# 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).
- [README.md](README.md)
- [run.sh](run.sh)
- [LICENSE](LICENSE)
- [docs.conf.example](docs.conf.example)
- [divio-docs-gen](divio-docs-gen)
- [docs.conf](docs.conf)
- [tmp](tmp)
- [Divio-Docs-Repo](Divio-Docs-Repo)
- [doctest](doctest)
- [ember-data-table](ember-data-table)
- [ember-proxy-service](ember-proxy-service)
- [Learning.md](Learning.md)
- [Matrix-Bot-Starter](Matrix-Bot-Starter)
- [Matrix-Bot-Starter-Starter](Matrix-Bot-Starter-Starter)
- [Mermatrix](Mermatrix)
- [Mermatrix-archive](Mermatrix-archive)
- [mu-cl-resources](mu-cl-resources)
- [mu-dispatcher](mu-dispatcher)
- [mu-docs](mu-docs)
- [mu-identifier](mu-identifier)
- [mu-javascript-template](mu-javascript-template)
- [mu-migrations-service](mu-migrations-service)
- [mu-project](mu-project)
- [mu-ruby-template](mu-ruby-template)
- [mu-search](mu-search)
- [mu-semtech-getting-started](mu-semtech-getting-started)
- [project](project)
- [rarwe-backend](rarwe-backend)
- [semantic-docs](semantic-docs)
- [Sparqlix](Sparqlix)
4 changes: 4 additions & 0 deletions docs.conf.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[DEFAULT]
FallbackOwner=Denperidge-Redpencil
GenerateNav=True
DocsBasedir=../
3 changes: 1 addition & 2 deletions run.sh
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
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
cp ../docs.conf .
python3 app/index.py

0 comments on commit 0d12c84

Please sign in to comment.