From 962ebf817ae042b14e3bbf54ddf812910d112116 Mon Sep 17 00:00:00 2001 From: Andy Joslin Date: Thu, 13 Mar 2014 07:27:58 -0600 Subject: [PATCH] docs: add README explaining templates --- docs/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000000..7b0aa84756 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,15 @@ +Editing Doc Pages +----------------- + +After following these steps: https://github.com/driftyco/ionic#documentation + +**Templates in `template` folder** + +(src) => (dest) + +- `pages-data.template.html` => `_layout/docs_0.9.0.html` +- `index.template.html` => The 'index' page for a doc version - http://ajoslin.github.io/docs/0.9.26/ +- `yaml.template.html` => the common yaml config items that every doc page includes +- `api/componentGroup.template.html` => the template for every 'componentGroup' (eg http://ajoslin.github.io/docs/0.9.26/api/ionic/directive/) +- `api/api.template.html` - the base that every doc-item extends from +- `api/{something}.template.html` - the template for {something} - eg directive.template.html for directives