fernandoescolar / njekyll

Another static blog generator like Jekyll in dotnet
Other
1 stars 0 forks source link

Enhance documentation #1

Open GunArm opened 2 months ago

GunArm commented 2 months ago

Jekyll is slow and I'm often thinking of making a largely compatible port in dotnet with async or even multi-core support. I was just poking at Fluid and came across this. I know this isn't something you're active on, but it seems like a great project. It looks like you did a lot of legwork bringing all the legos together and with a pretty clean architecture.

It would be nice if there was some docs or a sample site with placeholders to show what it is capable of. From browsing the code it looks like it takes the same yaml configs, a roughly similar site source structure, handles markdown, liquid, parses sass. Of course the edges of "close enough to jekyll" would be different for different users, for example I can't tell that it supports collections (as opposed to the central "posts" collection). Does it support additional _data yml? Is there a pattern for adding custom liquid tags/filters?

I can see there is a lot of value here, it's just hard to approach without an overview of it's state (particularly in comparison to jekyll). Also, are you still using it? Are you interested in taking pull requests or kinda "done" with it?

fernandoescolar commented 2 months ago

I was trying to replace jekyll in my blog (https://github.com/fernandoescolar/fernandoescolar.github.io). But I found several problems with the liquid language parser and also with code blocks that I could easily solve with jekyll.

This project is a proof of concept. I recommend you to boilerplate a jekyll project and try to remove everything that doesn't work. Then you will be able to improve it.