summaryrefslogtreecommitdiffstats
path: root/create-a-wiki
diff options
context:
space:
mode:
authorGustav Eek <gustav.eek@fripost.org>2019-10-06 01:54:59 +0200
committerGustav Eek <gustav.eek@fripost.org>2019-10-06 01:54:59 +0200
commitaf9fc961b42807aa747060eaa2d97f3a78f67789 (patch)
tree67581c4ce51fad2e032817582eb0a2688ee20b8c /create-a-wiki
parentceaba1dbb9f4352aba14397e9ae5f3da34b25eac (diff)
Provide inital on instructions for development setup
Diffstat (limited to 'create-a-wiki')
-rw-r--r--create-a-wiki/development.mdwn40
1 files changed, 40 insertions, 0 deletions
diff --git a/create-a-wiki/development.mdwn b/create-a-wiki/development.mdwn
new file mode 100644
index 0000000..60c5f74
--- /dev/null
+++ b/create-a-wiki/development.mdwn
@@ -0,0 +1,40 @@
+---
+title: Adoptions for taking part of function development
+...
+
+Here follows again configuration and upgrades for those that take part
+in development of Fripost's wiki; that is the actual wiki, not the
+contents.
+
+What is development of actual wiki? That can of course be many, but
+some examples contains:
+
+ * Templates that are part of site generations
+ * Styles, CSS, etc. that will change the look
+ * Plugins that extract data from the original text content, e.g. the
+ Pandoc plugin
+ * User side JavaScript and other front end aspects that enriches the
+ reading experience
+
+The prerequisites for good development are (1)
+a [local setup](/create-a-wiki-preview) of the wiki, (2) library
+components (plugins) from the repository and (3) recent version of the
+software components.
+
+**Local wiki preview.** Follow instructions in the
+article [Create a Fripost wiki preview](/create-a-wiki-preview).
+
+**Libraries from the Fripost wiki repository.** Change the wiki
+library path to point to directory *.ikiwiki* in the Git repository
+(which happen to be `srcdir`):
+
+```
+setup="$HOME/.ikiwiki/fripost-wiki.setup"
+srcdir=$(sed -n '/^srcdir:/ {s/.*: //; p}' "$setup")
+sed "/^libdir:/ s|:.*$|: $srcdir/.ikiwiki|" -i "$setup"
+```
+
+**Upgrade Ikiwiki.** *TODO fill in how to do this.*
+
+**Upgrade Pandoc.** *TODO fill in how to do this.*
+