Noddsdale Readme
Noddsdale is a static blog generator using Markdown and Node.js.
Why build another blog engine?
There are lots of blog engines out there including many that produce a static site from Markdown files. Noddsdale is a learning exercise for the purpose of building such a generator myself.
The name Noddsdale
The name Noddsdale comes from Noddsdale Water, Largs, Ayrshire, Scotland. I love kayaking, and as a child, I spent a lot of time in Largs as this is my father's hometown, so I decided to reference one of the waterways of my childhood as the name for this project.
How to use
Currently, Noddsdale does not do anything. However, the plan as outlined in ROADMAP.md is to do the following:
- Create and change to the root directory of your blog.
- Initialise a new blog
noddsdale init. - Generate the blog
noddsdale build. - Host the blog locally
noddsdale host.
Developer Guide
For information on developing Noddsdale, refere to the Developer Guide
Depenencies
I am thankful of the hard work done by others in the community. In particular noddsdale makes use of:
Roadmap
The roadmap outlines the plans for implementing the high priority features and enhancement. The roadmap is found in the ROADMAP.md file.
License
This project follows the terms of the MIT license