summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYann Herklotz <git@yannherklotz.com>2023-05-28 15:54:11 +0100
committerYann Herklotz <git@yannherklotz.com>2023-05-28 15:57:27 +0100
commitf1cd03b703e1b9712e0b3fc156c51cc1cde1f9de (patch)
tree76e2efacaa455e31d9333d94d695c92a37783ed2
parent846c9411e6f7d91a36527e798505fd3b4541adaa (diff)
downloadzk-visual-f1cd03b703e1b9712e0b3fc156c51cc1cde1f9de.tar.gz
zk-visual-f1cd03b703e1b9712e0b3fc156c51cc1cde1f9de.zip
Release Version 0.2.0.0v0.2.0.0
- Support org bibliography file for bibliographic notes in the Zettelkasten. - Add documentation to various functions.
-rw-r--r--CHANGELOG.org11
-rw-r--r--org-zk.cabal22
-rw-r--r--src/Main.hs2
-rw-r--r--src/Zettel.hs2
-rw-r--r--src/Zettel/Bibliography.hs2
-rw-r--r--src/Zettel/Common.hs2
-rw-r--r--src/Zettel/Links.hs2
-rw-r--r--src/Zettel/Math.hs2
-rw-r--r--src/Zettel/Parse.hs2
-rw-r--r--src/Zettel/Render.hs2
-rw-r--r--src/Zettel/Transclusion.hs2
-rw-r--r--src/Zettel/Types.hs2
12 files changed, 35 insertions, 18 deletions
diff --git a/CHANGELOG.org b/CHANGELOG.org
new file mode 100644
index 0000000..eda366b
--- /dev/null
+++ b/CHANGELOG.org
@@ -0,0 +1,11 @@
+#+title: Org-ZK Changelog
+
+* Org-ZK 0.2.0.0
+
+- Support org bibliography file for bibliographic notes in the Zettelkasten.
+- Add documentation to various functions.
+
+* Org-ZK 0.1.0.0
+
+- Support basic parsing of Org zettelkasten and splitting it up into markdown
+ files.
diff --git a/org-zk.cabal b/org-zk.cabal
index 0cad8f0..9273bbf 100644
--- a/org-zk.cabal
+++ b/org-zk.cabal
@@ -1,25 +1,31 @@
cabal-version: 2.4
name: org-zk
-version: 0.1.0.0
+version: 0.2.0.0
license: GPL-3.0-only
-copyright: 2021-2023 Yann Herklotz
+license-file: LICENSE
+copyright: (c) 2021-2023 Yann Herklotz
maintainer: git@yannherklotz.com
author: Yann Herklotz
+homepage: https://git.sr.ht/~ymherklotz/zk-visual
category: Web
--- TODO: Before hackage release.
-- A short (one-line) description of the package.
--- synopsis:
+synopsis: Translate Org Zettelkasten into markdown for a static site generator.
-- A longer description of the package.
--- description:
+description: Exports an Org Zettelkasten to markdown files which can then be
+ passed to a static site generator. It also supports gathering
+ backlinks for each note as well as forward links, in addition to
+ supporting citations of a bibliography.
+
+ It uses Pandoc heavily to implement these features, and implements
+ a custom parser and renderer to split up the Zettel appropriately.
-- A URL where users can report bugs.
--- bug-reports:
+bug-reports: https://lists.sr.ht/~ymherklotz/public-inbox
extra-source-files:
- LICENSE
- README.md
+ - README.md
data-files:
data/*.template
diff --git a/src/Main.hs b/src/Main.hs
index 47dc859..9d16c0d 100644
--- a/src/Main.hs
+++ b/src/Main.hs
@@ -4,7 +4,7 @@
-- Module : Main
-- Description : Command-line interface for org-zk
-- Copyright : (c) 2023, Yann Herklotz
--- License : GPL-3
+-- License : GPL-3.0-only
-- Maintainer : git [at] yannherklotz [dot] com
-- Stability : experimental
-- Portability : POSIX
diff --git a/src/Zettel.hs b/src/Zettel.hs
index 535a5b4..1f5777d 100644
--- a/src/Zettel.hs
+++ b/src/Zettel.hs
@@ -2,7 +2,7 @@
-- Module : Zettel
-- Description : Main Zettel library file
-- Copyright : (c) 2023, Yann Herklotz
--- License : GPL-3
+-- License : GPL-3.0-only
-- Maintainer : git [at] yannherklotz [dot] com
-- Stability : experimental
-- Portability : POSIX
diff --git a/src/Zettel/Bibliography.hs b/src/Zettel/Bibliography.hs
index 42476be..6dddeb1 100644
--- a/src/Zettel/Bibliography.hs
+++ b/src/Zettel/Bibliography.hs
@@ -4,7 +4,7 @@
-- Module : Zettel.Bibliography
-- Description : Render bibliography citations to links to org bibliography
-- Copyright : (c) 2023, Yann Herklotz
--- License : GPL-3
+-- License : GPL-3.0-only
-- Maintainer : git [at] yannherklotz [dot] com
-- Stability : experimental
-- Portability : POSIX
diff --git a/src/Zettel/Common.hs b/src/Zettel/Common.hs
index 5d703e2..fe43e3a 100644
--- a/src/Zettel/Common.hs
+++ b/src/Zettel/Common.hs
@@ -4,7 +4,7 @@
-- Module : Zettel.Common
-- Description : Shared functions used throughout the project
-- Copyright : (c) 2023, Yann Herklotz
--- License : GPL-3
+-- License : GPL-3.0-only
-- Maintainer : git [at] yannherklotz [dot] com
-- Stability : experimental
-- Portability : POSIX
diff --git a/src/Zettel/Links.hs b/src/Zettel/Links.hs
index dd467de..24977ce 100644
--- a/src/Zettel/Links.hs
+++ b/src/Zettel/Links.hs
@@ -4,7 +4,7 @@
-- Module : Zettel.Links
-- Description : Calculate the backlinks and forward links for each Zettel
-- Copyright : (c) 2023, Yann Herklotz
--- License : GPL-3
+-- License : GPL-3.0-only
-- Maintainer : git [at] yannherklotz [dot] com
-- Stability : experimental
-- Portability : POSIX
diff --git a/src/Zettel/Math.hs b/src/Zettel/Math.hs
index fd335a4..e693e83 100644
--- a/src/Zettel/Math.hs
+++ b/src/Zettel/Math.hs
@@ -2,7 +2,7 @@
-- Module : Zettel.Math
-- Description : Wrap math with hugo raw-html markers
-- Copyright : (c) 2023, Yann Herklotz
--- License : GPL-3
+-- License : GPL-3.0-only
-- Maintainer : git [at] yannherklotz [dot] com
-- Stability : experimental
-- Portability : POSIX
diff --git a/src/Zettel/Parse.hs b/src/Zettel/Parse.hs
index 3f52972..9a9fc96 100644
--- a/src/Zettel/Parse.hs
+++ b/src/Zettel/Parse.hs
@@ -2,7 +2,7 @@
-- Module : Zettel.Parse
-- Description : Parse the org-zettelkasten files and split them into Zettel
-- Copyright : (c) 2023, Yann Herklotz
--- License : GPL-3
+-- License : GPL-3.0-only
-- Maintainer : git [at] yannherklotz [dot] com
-- Stability : experimental
-- Portability : POSIX
diff --git a/src/Zettel/Render.hs b/src/Zettel/Render.hs
index c4bb7af..0e7f436 100644
--- a/src/Zettel/Render.hs
+++ b/src/Zettel/Render.hs
@@ -4,7 +4,7 @@
-- Module : Zettel.Render
-- Description : Render the Zettelgraph to multiple markdown files
-- Copyright : (c) 2023, Yann Herklotz
--- License : GPL-3
+-- License : GPL-3.0-only
-- Maintainer : git [at] yannherklotz [dot] com
-- Stability : experimental
-- Portability : POSIX
diff --git a/src/Zettel/Transclusion.hs b/src/Zettel/Transclusion.hs
index 6bc7b2b..51efe3a 100644
--- a/src/Zettel/Transclusion.hs
+++ b/src/Zettel/Transclusion.hs
@@ -4,7 +4,7 @@
-- Module : Zettel.Transclusion
-- Description : Transclude Zettel recursively
-- Copyright : (c) 2023, Yann Herklotz
--- License : GPL-3
+-- License : GPL-3.0-only
-- Maintainer : git [at] yannherklotz [dot] com
-- Stability : experimental
-- Portability : POSIX
diff --git a/src/Zettel/Types.hs b/src/Zettel/Types.hs
index 3d3f793..536bc06 100644
--- a/src/Zettel/Types.hs
+++ b/src/Zettel/Types.hs
@@ -9,7 +9,7 @@
-- Module : Zettel.Types
-- Description : Type definitions of ZettelGraph
-- Copyright : (c) 2023, Yann Herklotz
--- License : GPL-3
+-- License : GPL-3.0-only
-- Maintainer : git [at] yannherklotz [dot] com
-- Stability : experimental
-- Portability : POSIX