Hakyll ignores '.md' extensions?

[Chris Mountford]

Hi All,

`hakyll-init foo` generates a working site but if I rename `about.rst` to `about.md` and `contact.markdown` to `contact.md` and of course update the match patterns in `site.hs` and `cabal build && site rebuild` the about and contact pages are not generated. OS: macos

Here's a script that demonstrates the failure automatically:

https://gist.github.com/christo/86245bff11846e21a1171c4ea46f56ac

I note some featured hakyll sites use `.md` but other complexities also present make it unclear how I could learn from that. 

regards,

Chris.

[Kyle Marek-Spartz]

You'll need to change the site.hs file. Thankfully, most of the logic you are putting in shell can go there instead.

My site is a bit out of date but here's an example: https://github.com/kmarekspartz/kyle.marek-spartz.org/blob/master/site.hs#L51

–

Kyle Marek-Spartz

On Sep 17, 2024, at 01:47, Chris Mountford <chris.m...@gmail.com> wrote:

Hi All,

--
You received this message because you are subscribed to the Google Groups "hakyll" group.
To unsubscribe from this group and stop receiving emails from it, send an email to hakyll+un...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/hakyll/eb6d74b8-1133-40f8-a405-e1a5477bee27n%40googlegroups.com.

[Laurent P. René de Cotret]

Hey Chris,

Thanks for providing a minimum example. I just ran it and it initially didn't work because of a silent failure in the check function in the test script.

With minor modifications, it worked:

```

# Deterministic test directory

testdir="test"

# Make sure we set up a cabal project

echo "packages: test.cabal" >> cabal.project

function check() {

# Ensure to run the test executable through cabal run

   if !(cabal build test && cabal run test -- rebuild && cabal run test -- check); then

       popd; echo; echo failed on $1; exit 1

   else

       echo; echo success on $1

   fi

}

hakyll-init "$testdir"

pushd "$testdir"

check "generated example"

mv about.rst about.md

mv contact.markdown contact.md

perl -pi -e 's/\.(markdown|rst)/.md/g' site.hs

check "modified example"

popd

```

Ubuntu 23.04 and Hakyll 4.16.2.0.

Laurent

---

From: hak...@googlegroups.com <hak...@googlegroups.com> on behalf of Chris Mountford <chris.m...@gmail.com>
Sent: September 17, 2024 2:03 AM
To: hakyll <hak...@googlegroups.com>
Subject: [hakyll] Hakyll ignores '.md' extensions?

 

--

[Chris Mountford]

Thanks for the reply Kylie.

As I said I do change site.hs. Of course I did this manually but I provide the shell script to demonstrate the problem I am seeing by minimally changing the working, generated example site. If I change site.hs and the source markdown files I do not see the files transformed to html. The script explicitly shows this problem by running `site check` which detects dead links.

[Chris Mountford]

Hi Laurent,

Thanks for taking the time to check this. I'm very confused by your reply. I'm not sure what you mean when you say you changed my script and then "it worked".

So we're all clear: I wrote this script to demonstrate a problem for the benefit of explaining what I am trying to do. The script is not for my static site. It is entirely written for explaining my situation to you good people while I evaluate hakyll. I expect the script to fail in the `check` function for everyone and print the message "failed on modified example"

The Hakyll installation instructions show how to install hakyll and use hakyll-init to create an example project: 

https://jaspervdj.be/hakyll/tutorials/01-installation.html

When I followed these instructions I did see that the example static site was correctly generated.  `site check` shows no dead links.

My script first does this too: builds it and checks it. It shows that it works!

Then the script changes the file extensions, patterns, rebuilds the site executable with cabal and rebuilds the static site with the site executable. 

Then it runs check again but that time it fails to generate the site correctly and `site check` shows there are dead links.

It looks like you have changed the test script so that it no longer demonstrates the problem. It no longer calls the `site` executable built by `hakyll-init`.

You do not need the script to see the problem. All you have to do is call hakyll-init, rename about.rst to about.md and contact.markdown to contact.md then update the site.hs file to use the two new filenames. Then you must run `cabal build` and if you have previously run `site build` you must also run `site rebuild`. At that point you can see the site did not correctly generate and you can confirm this by running `site check`. Or you can just run the script to see this.

I would like to understand why the problem is happening and how to fix it. I don't want help to modify the test script so that it does not fail to demonstrate the problem.

Also your modified script failed for me with the message:

```
When using configuration(s) from /Users/christo/tmp/hakyll-test/cabal.project, the following errors occurred:
The package location 'test.cabal' does not exist.
```

If I have misunderstood your intentions here I'm sorry!

Chris

[Chris Mountford]

OK I just tested this on Linux and the problem is not evident so perhaps this is a MacOS specific bug?
Also, even on MacOS, if I rename the .markdown files inside posts/ to have .md extensions these are correctly processed by Hakyll. 

[Chris Mountford]

SOLVED

OK the problem seems to be my ignorance of cabal. It seems while I did rebuild the site executable with cabal build, evidently I had previously done cabal install which put site on my path in $HOME/.cabal/bin but I had not run that again after making the changes to site.hs which meant the site executable that ran was old.

Thanks again Kyle and Laurent for your help.