incandescentman
incandescentman

Reputation: 6368

automatically create mini-website from Markdown files?

Is there a tool that will automatically generate a mini-website---with automatically generated navigation---from locally-stored Markdown files?

I'm envisioning a service that will integrate with my Dropbox, look at the file structure, look at the Markdown files, and automatically create a clean little site with my pages and with hierarchical navigation.

Full-text search would be cool but not required.

Does such a tool exist?

Upvotes: 5

Views: 2342

Answers (5)

Ghominejad
Ghominejad

Reputation: 1798

You can use Docusaurus the open source project from Facebook!

Simply write docs and blog posts with Markdown/MDX and Docusaurus will publish a set of static HTML files ready to serve.

I've wrote a simple plugin for Docusaurus that automatically generates the sidebar menu from file/folder structure so you even don't have to define them manually!

Upvotes: 1

benweet
benweet

Reputation: 3713

I'm the developer of StackEdit, a Markdown editor that can be used as a blogging client. You can use it to write your document and directly publish it in HTML format to your blog (Blogger, WordPress, Tumblr or Jekyll via through GitHub).

Upvotes: 1

Cory Gross
Cory Gross

Reputation: 37206

The general term for the tool you speak of is called a static site generator. They are a new trend in web publishing and there are literally tons of them and new ones coming out all the time. Most of them have markdown support so you will have a task in choosing the best one.

My introduction to the topic was reading this blog post, An Introduction to Static Site Generators by Michael Gardner. If you're interested in the subject I would recommend giving it a read. It discusses the advantages to using such a strategy over a dynamic one, and also compares multiple generators. The comparison includes and ends up focusing on Jekyll which is probably the most popular static site generator as far as I can tell.

Also you will probably want to read Node Based Static Site Generators by Boris Mann who is also looking into Dropbox support as well. I have been looking into different static site generators as well and a few that I have noticed, but haven't had a chance to look at much:

Upvotes: 6

luciash d' being
luciash d' being

Reputation: 318

It sounds like Skrivr does just that: http://skrivr.com/

Upvotes: 0

Sir l33tname
Sir l33tname

Reputation: 4330

I think jekyll could do it. Jekyll is a blog-aware, static site generator in Ruby and you could host it direct on github if you want.

Upvotes: 4

Related Questions