summaryrefslogtreecommitdiffstats
path: root/gbdk/docs/config/github-markdown-theme/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'gbdk/docs/config/github-markdown-theme/README.md')
-rw-r--r--gbdk/docs/config/github-markdown-theme/README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/gbdk/docs/config/github-markdown-theme/README.md b/gbdk/docs/config/github-markdown-theme/README.md
new file mode 100644
index 00000000..0d70ad60
--- /dev/null
+++ b/gbdk/docs/config/github-markdown-theme/README.md
@@ -0,0 +1,11 @@
+Doxygen theme to style HTML output similar to Github Markdown
+=============================================================
+
+This is a quick and dirty hack so that the Doxygen HTML output resembles Github
+Markdown pages with a tree view navigator on the left. I am an HTML and CSS
+novice and any fixes or improvements are most welcome!
+
+Click [HERE](https://piconomix.com/fwlib/index.html) to view an example using
+this Doxygen CSS theme.
+
+Enjoy!