branch: externals/bind-key
commit cdd59d5a9d1e11740af615b6c74afec2046d1861
Author: Payas Relekar <relekarpa...@gmail.com>
Commit: Payas Relekar <relekarpa...@gmail.com>
Add README.org to explain purpose of doc/ directory
..and add doc/* directory to .elpaignore
---
.elpaignore | 1 +
doc/README.org | 12 ++++++++++++
2 files changed, 13 insertions(+)
diff --git a/.elpaignore b/.elpaignore
index 2e84c1351d..d9ca1c78a6 100644
--- a/.elpaignore
+++ b/.elpaignore
@@ -1 +1,2 @@
.travis.yml
+doc/*
diff --git a/doc/README.org b/doc/README.org
new file mode 100644
index 0000000000..f16d19563e
--- /dev/null
+++ b/doc/README.org
@@ -0,0 +1,12 @@
+#+title: use-package Documentation generator
+:PREAMBLE:
+#+author: Payas Relekar
+#+email: relekarpa...@gmail.com
+#+date: 2022-{{{year}}}
+#+language: en
+
+This directory contains necessary scripts and static resources to generate
+online documentation for at
[[https://jwiegley.github.io/use-package/][use-package]].
+
+The static site generator used is [[https://gohugo.io/][Hugo]] and uses
org-mode documents from this
+repository via [[https://github.com/kaushalmodi/ox-hugo][ox-hugo]] org-mode to
markdown converter.
