Skip to content

ankyra/escape-docs

Repository files navigation

Escape Documentation

This repository contains (most of the) documentation for Escape and the Escape Inventory. It contains the introduction, quickstart and reference documentation, and it also generates the downloads page.

The reference documentation is copied from the escape-core and escape releases, which generate these pages from their golang structs in their build phase.

The build requires a working hugulp and hugo installation.

Note for non-Ankyra people: you can't currently use escape to build this release as we haven't open sourced all the required pieces yet, but hugulp should work.

License

Copyright 2017 Ankyra

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.