diff options
| author | Fuwn <[email protected]> | 2022-02-04 17:38:04 -0800 |
|---|---|---|
| committer | Fuwn <[email protected]> | 2025-06-09 00:43:14 -0700 |
| commit | 8a78f62e4cb0890cd0ed9c663a21f809013b959e (patch) | |
| tree | be25df618590569d62f3279a1c2cdffd7ddeeb08 /lib/graphite/readme.md | |
| download | documentation-8a78f62e4cb0890cd0ed9c663a21f809013b959e.tar.xz documentation-8a78f62e4cb0890cd0ed9c663a21f809013b959e.zip | |
feat: setup documentation
Diffstat (limited to 'lib/graphite/readme.md')
| -rw-r--r-- | lib/graphite/readme.md | 37 |
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. |