aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorDenis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>2023-12-26 16:01:56 +0100
committerDenis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>2023-12-31 13:11:42 +0100
commitdac22e627f3c716201556537849743387464c73d (patch)
treea79c1eaeadc0697f72075a2f88a0ab6188bd90cf /README
downloadhaunt-blog-dac22e627f3c716201556537849743387464c73d.tar.gz
haunt-blog-dac22e627f3c716201556537849743387464c73d.tar.bz2
haunt-blog-dac22e627f3c716201556537849743387464c73d.zip
Initial import
Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Diffstat (limited to 'README')
-rw-r--r--README47
1 files changed, 47 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..1d9e14f
--- /dev/null
+++ b/README
@@ -0,0 +1,47 @@
+Introduction
+============
+This is a set of scripts that can be used to do a semi-automatic
+migration from WordPress to haunt, a static website generator.
+
+The code is a bit fragile and parses untrusted data so a human is
+required to review if there are any suspicious data at several steps
+in the migration process.
+
+Usage
+=====
+
+First run 'make links.txt' manually to produce the links.txt file.
+Then you need to manually inspect it to see if it contains dangerous
+or problematic characters / text.
+
+Then you need to run run 'make markdown' to download all the blog
+posts in html/ and convert them to markdown (and store them in
+markdown/).
+
+At this point the dates inside the file need to be fixed because at
+the time of writing haunt doesn't support the same date format than
+WordPress yet.
+
+Since the dates are again untrusted data, a human needs to review them
+with the './fix-dates.sh preview markdown/*' command.
+
+If no strange data was found they then need to be converted with
+'./fix-dates.sh fix markdown/*'.
+
+At this stage the website is then ready to used with haunt. You can
+then build it with 'make build' or 'make serve'.
+
+License
+=======
+This project is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or (at
+your option) any later version.
+
+This project is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <https://www.gnu.org/licenses/>. \ No newline at end of file