summaryrefslogtreecommitdiff
path: root/lib/graphite/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'lib/graphite/readme.md')
-rw-r--r--lib/graphite/readme.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/lib/graphite/readme.md b/lib/graphite/readme.md
new file mode 100644
index 0000000..0f131cb
--- /dev/null
+++ b/lib/graphite/readme.md
@@ -0,0 +1,37 @@
+# Graphite
+
+[1]: https://github.com/dmulholl/ivy
+[2]: https://fonts.google.com/specimen/Crimson+Text
+
+A simple [Ivy][1] theme designed for generating project documentation.
+
+This theme will display the following attributes from the site's `config.py` file in the site header:
+
+* `title`
+* `tagline`
+
+It supports the following includes:
+
+* `menu`
+
+ This file will be used to construct the theme's main menu. It should contain
+ a list of links, optionally with nested sub-lists.
+
+* `head`
+
+ If a `head.html` file is present in the includes folder its content will be
+ included at the end of each page's `<head>` section. This file can be used
+ to add custom CSS or JavaScript to a site without directly editing the
+ theme's template files.
+
+* `foot`
+
+ If a `foot.html` file is present in the includes folder its content will
+ be included at the end of each page's `<body>` section. This file can be
+ used to add custom JavaScript to a site without directly editing the
+ theme's template files.
+
+This theme is distributed under the following license:
+
+* All code has been placed in the public domain.
+* The bundled [Crimson Text][2] font is distributed under the SIL Open Font License.