feat: move README back to root

.github/workflows/gh-pages.yml

@@ -1,11 +1,9 @@
 name: Deploy to GitHub Pages
 
 on:
-  push:
-    branches: ["main"]
-    paths:
-      - .github/workflows/gh-pages.yml
-      - "docs/**"
+  release:
+    types:
+      - "published"
 
 permissions:
   contents: read
@@ -27,7 +25,7 @@ jobs:
       - name: Build with Jekyll
         uses: actions/jekyll-build-pages@v1
         with:
-          source: ./docs
+          source: ./
           destination: ./_site
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3

README.md

@@ -1,7 +1,7 @@
 <div align="center">
 <h1>zk</h1>
 <h4>A plain text note-taking assistant</h4>
-<img alt="Screencast" width="95%" src="assets/media/screencast.svg"/>
+<img alt="Screencast" width="95%" src="docs/assets/media/screencast.svg"/>
 <p>Looking for a quick usage example? <a href="getting-started.md">Let's get started</a>.</p>
 </div>
 
@@ -39,29 +39,29 @@
 
 ### Highlights
 
-* [Creating notes from templates](note-creation.md)
-* [Advanced search and filtering capabilities](note-filtering.md) including [tags](tags.md), links and mentions
-* [Integration with your favorite editors](editors-integration.md):
-    * [Any LSP-compatible editor](editors-integration.md)
+* [Creating notes from templates](docs/note-creation.md)
+* [Advanced search and filtering capabilities](docs/note-filtering.md) including [tags](docs/tags.md), links and mentions
+* [Integration with your favorite editors](docs/editors-integration.md):
+    * [Any LSP-compatible editor](docs/editors-integration.md)
     * [`zk-nvim`](https://github.com/zk-org/zk-nvim) for Neovim 0.5+
     * [`zk-vscode`](https://github.com/zk-org/zk-vscode) for Visual Studio Code
     * (*unmaintained*) [`zk.nvim`](https://github.com/megalithic/zk.nvim) for Neovim 0.5+ by [Seth Messer](https://github.com/megalithic)
-* [Interactive browser](tool-fzf.md), powered by `fzf`
-* [Git-style command aliases](config-alias.md) and [named filters](config-filter.md)
-* [Made with automation in mind](automation.md)
-* [Notebook housekeeping](notebook-housekeeping.md)
-* [Future-proof, thanks to Markdown](future-proof.md)
+* [Interactive browser](docs/tool-fzf.md), powered by `fzf`
+* [Git-style command aliases](docs/config-alias.md) and [named filters](docs/config-filter.md)
+* [Made with automation in mind](docs/automation.md)
+* [Notebook housekeeping](docs/notebook-housekeeping.md)
+* [Future-proof, thanks to Markdown](docs/future-proof.md)
 * Supports most Markdown syntax flavors
     * Links: regular Markdown links, `[[Wikilinks]]` and Neuron's `[[Folgezettel links]]#`.
     * Tags: `#hashtags`, `:colon:separated:tags:`, Bear's `#multi-word tags#`.
-    * [YAML frontmatter](note-frontmatter.md)
+    * [YAML frontmatter](docs/note-frontmatter.md)
 
-[See the changelog](../CHANGELOG.md) for the list of upcoming features waiting to be released.
+[See the changelog](CHANGELOG.md) for the list of upcoming features waiting to be released.
 
 ### What `zk` is not
 
 * A note editor.
-* A tool to serve your notes on the web – for this, you may be interested in [Neuron](neuron.md) or [Gollum](https://github.com/gollum/gollum).
+* A tool to serve your notes on the web – for this, you may be interested in [Neuron](docs/neuron.md) or [Gollum](https://github.com/gollum/gollum).
 
 ## Install
 

_config.yml

@@ -0,0 +1,26 @@
+title: "zk"
+permalink: /:title
+defaults:
+  - scope:
+      path: "README.md"
+    values:
+      title: "zk"
+  - scope:
+      path: "" # all
+    values:
+      render_with_liquid: false
+exclude:
+  - ".github/"
+  - ".gitignore"
+  - "CHANGELOG.md"
+  - "CONTRIBUTING.md"
+  - "LICENSE"
+  - "Makefile"
+  - "go.mod"
+  - "go.sum"
+  - "internal/"
+  - "main.go"
+  - "tests/"
+include:
+  - "docs/**"
+

docs/_config.yml

@@ -1,11 +0,0 @@
-title: "zk"
-permalink: /:title
-defaults:
-  - scope:
-      path: "README.md"
-    values:
-      title: "zk"
-  - scope:
-      path: "" # all
-    values:
-      render_with_liquid: false

docs/assets/css/style.scss

@@ -1,9 +0,0 @@
----
----
-
-@import "{{ site.theme }}";
-
-code, pre {
-    font-size: inherit;
-}
-