README.md as a Personal Site

Jhon Paredes on December 11, 2018

After reading this article Evolution of My Personal Site I recalled how often I’d change my personal site as well. Most of the time I’d adopt a new... [Read Full]
markdown guide
 

Looks great! Thanks for writing this (the post and the Node app).

A couple questions for you:

  • RE: "Local dev workflows are nice, but it depends on how often you'd envision updating this site." do you mean something like using Jekyll to compile static HTML pages locally as a local dev workflow?
  • In the sample README.MD, did you add the beginning HTML with the singlemd header manually or is that generated from Markdown by the app?

I've been using Jekyll for a simple blog for my thesis writing and I like it but it seems overkill for a single page. I like the idea of the GitLab pipeline a lot vs. having to build the site and then push.

 

Hi Kevin, thank you for your feedback!

Regarding your questions:

  1. Yes, that's exactly what I meant. I had to run my local server, wait to compile, (update packages if needed), change content, commit, and push. I just wanted to change my content and push. Plus be confident that whatever markdown editor (albeit with GFM) would reflect how my page would look like.

  2. I added that html myself. I took inspiration from bootstrap's README to center the title header. Since markdown accepts a limited amount of html I can manipulate certain positioning without having to resort to css.

Using Gitlab Pipeline has been great to automating my personal site's development flow -- since I only have to worry about my content. Hopefully Github Actions will work in a similar fashion and can extend to Github Pages.

 

I have been looking for sth similar for simple and easy to maintain website. I am not sure if it is possible to add custom class name into Markdown file and render into html? That would be great to apply styling to specific area.

 

Hi Rattanak,

I'm not sure if I'm answering your question correctly, but each markdown output will be within an <article class="markdown-body"> which you can then add any style that you wish. Since cli allows you to add a custom css which will be inserted after the GFM style.

If instead you're referring to adding something like:

{:.nameofclass}
paragraph is here

I'm not sure if markdown-it (the markdown parser I'm using) would support it. Feel free to add an issue to discuss further.

 

This is interesting. I have been trying to build personal blog solutions for this very purpose. I first started web development writing blog files as JSON and ajaxing them into my site (when it was a single page site) and later on with PHP JSON parsing (when it was a PHP site). Lately I am working on a node version of my site which uses a markdown library, while the other pages are still EJS templates, the blog posts are rendered markdown pages.

Looking forward to following your article later in free time to give this a try myself, not sure I'm fond of making the entire website as markdown though.

 

Hi Michael,

Thank you for the feedback!

I was definitely hesitant at first with developing with just markdown. There's a lot of limitations that come with this approach. But within those limitations I found myself being at ease with not continuously "optimizing" my workflow.

I'd be interested to see what you come up with. Always looking to improve the personal site process. Good luck!

 

This was a very pleasant read itself. A really interesting train of thought and outcome.

This is simple and delightfully declarative.

 

Hi Ben, thank you very much for your kind comment! :D

 

sooo... Couldn't you have used something like sed to replace a string like <!-- content goes here --> in a template file with the rendered markdown?

 

Hi DarkWiiPlayer,

Yes, I could've definitely done that. But I also wanted the flexibility to manipulate the template file using a single line in the cli. Like adding custom css or changing the title.

 
code of conduct - report abuse