Load repository file into documentation

Sometimes you need to render a file which is part of the repository.

Prerequisites

The file needs to be available to the docker image running, so you will need to provide it.

Local doc server

• add it to a binding, either through directory or individual files. *recommended is to bind the file to a location in the resources directory( )

Render the file

**[Features](#features) • [Get Started](#get-started)**

This project can be used as a template for repository documentation.
It's goal is two-fold:

- provide usage examples on how a diataxis based documentation could work including features from mkdocs that allow lighting up the content.
- provide a drop-in documentation framework anyone can just intall into their repository

To see a working example, see [diataxis-template](https://diataxis-template.readthedocs.io/en/latest/).
Pro-tip: make sure you add the link to the working example so you can off-load learning how to use the template to the example

### Features

- [x] Basic diataxis structure
- [x] MkDocs basic config
- [x] Convention based folder structure using awesome-pages
- [x] read the docs
- [X] Basic templates
- [X] Printing of the entire site
- [ ] Distribution scripts

## Get Started

- See [Getting Started](tutorials/getting-started) for a tutorial on getting started with development
- See [Tutorials](tutorials/) section for all tutorials

## FAQ

See [faq](reference/faq.md) for a list of known issues.

## Contributing

Please see [contributing guide](reference/contributing.md) for more information.

## License

See [license page](reference/license.md) or `LICENSE.md` file for more information.

## Acknowledgements

Diataxis templates was based on [adolfomaltez/diataxis](https://github.com/adolfomaltez/diataxis)

References:

- [Awesome pages plugin](https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin)
- [Page tree plugin](https://github.com/tombreit/mkdocs-pagetree-plugin)

see docs for more information on how to use this snippet