Skip to content

Commit

Permalink
Updated README to reflect divio-docs-gen docs.conf
Browse files Browse the repository at this point in the history
I totally didn't write this before and then accidentally override it in the last commit
  • Loading branch information
Denperidge authored Jan 25, 2023
1 parent 9b439d2 commit bb53e4d
Showing 1 changed file with 10 additions and 30 deletions.
40 changes: 10 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,10 @@
- [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)
# 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 create your docs.conf file in the cloned folder and run `./run.sh`! It can be automated using GH Actions or crontab.
If you want to put the docs output in this folder, make sure to set `DocsBasedir=../`. 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).

0 comments on commit bb53e4d

Please sign in to comment.