improve doc (#10)

* improve doc * improve doc
klibio · May 20, 2024 · 190f277 · 190f277
1 parent 03f5cca
commit 190f277
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 # example for Eclipse RCP applications
 
+{{ page.date| date: "%m-%d-%Y" }}
+
 ## build pipelines
 
 | github action | output |

diff --git a/_doc/README.md b/_doc/README.md
@@ -0,0 +1,7 @@
+# hosting this folder for local development
+
+```bash
+# https://help.github.com/articles/creating-an-access-token-for-command-line-use/
+export JEKYLL_GITHUB_TOKEN=<github-pat-token>
+jeykll serve
+```
diff --git a/_doc/_config.yml b/_doc/_config.yml
@@ -1,6 +1,12 @@
+plugins:
+  - jekyll-github-metadata
+  - jekyll-seo-tag
+  - jekyll-sitemap
 markdown: kramdown
 
 github: [metadata]
+repository: klibio/example.pde.rcp
+
 defaults:
   -
     scope:

diff --git a/_doc/index.md b/_doc/index.md
@@ -1,3 +1,6 @@
 # example.pde.rcp
 
 more doc to be added here
+
+<sup>last edit: {{ 'now' | date: "%Y%m%d-%H%M%S" }}</sup><br/>
+<sup>git-commit-id:<a href="https://github.com/klibio/example.pde.rcp/commit/{{ site.github.build_revision }}">{{ site.github.build_revision }}</a></sup>