markdown-here VS Jekyll

Markdown Cheat Sheet: Markdown syntax guide for creating rich text formatting.

# Heading 1 ## Heading 2 ### Heading 3 Emphasis, aka italics, with *asterisks* or _underscores_. Strong emphasis, aka bold, with **asterisks** or __underscores__. Combined emphasis with **asterisks and _underscores_**. 1. First ordered list item 2. Another item ⋅⋅* Unordered sub-list. 1. Actual numbers don't matter, just that it's a number ⋅⋅1. Ordered sub-list 4. And another item. [I'm an inline-style link](https://www.google.com) [I'm an inline-style link with title](https://www.google.com "Google's Homepage") 

It's definitely a workaround, but I use a Chrome extension to work around this a bit. I use "Markdown Here" to add a "turn Markdown text to formatted text" button to my Chrome bar:

https://markdown-here.com/

And then I use it on plain Markdown text in a GMail compose window. The rich formatted output it produces can then be pasted into a Google Doc, and it comes out really nicely, including support for headers, sub-headers, links, code blocks, and the rest. The main issue is that this is a one-way process, but so long as you keep the .md source somewhere else, lets you share a richly-formatted doc with others for final commenting/editing/etc.

Here is a reference guide for the basic syntax of Markdown. Experiment and enjoy!

Means I made changes to the post formatting using Markdown https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet

markdown syntax Can be used to format your read me.

Proper formatting is key to ensure that your post is readable, helpful, and polished. Our post editor uses Markdown and Jekyll Front Matter to format posts.

You can also use more complex Markdown features like lists and tables. Check out the [Markdown Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) from Adam Pritchard for more information. ### Other JSDoc tags 📚 There are a few other JSDoc tags that you may find useful: - `@function` or `@func`: Documents a function or method. - `@class`: Documents a class constructor. - `@constructor`: Indicates that a function is a constructor for a class. - `@extends` or `@augments`: Indicates that a class or type extends another class or type. - `@implements`: Indicates that a class or type implements an interface. - `@namespace`: Groups related items, such as functions, classes, or types, under a common namespace. - `@memberof`: Specifies that an item belongs to a class, namespace, or module. - `@ignore`: Tells JSDoc to exclude an item from the generated documentation. - `@deprecated`: Marks a function, class, or property as deprecated, indicating it should no longer be used. - `@since`: Documents the version when an item was introduced. And many more. You can find a full list of JSDoc tags [here](https://jsdoc.app/). Ok ok, enough of the theory. Let's see how we can use JSDoc in practice.  ## Using JSDoc in practice 🏄‍♂️ There are a few challenges when starting to use JSDoc in your project. So this section will focus on these challenges and how you can overcome them. ### How to get the most out of JSDoc In this post I'm going to stick with VSCode. If you're using another editor, you can still follow along, but you might have to look up how to configure things in your editor. VSCode has built-in support for JSDoc. This means that you can get a lot of the JSDoc benefits without having to install any additional extensions. But there are a few things that you can do to get even more out of JSDoc. Enabling the checkJs option in your `jsconfig.json` file will make the editor display errors for type mismatches, even in JavaScript files. Place it in the root of your project or in the folder where you want to enable type checking. This file can look like this: ```json { "compilerOptions": { "checkJs": true, } }

Reddit uses Markdown, it's a pretty ubiquitous markup for formatting text online. You'll find it's used in a lot of places. https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet

This blog is running on Hugo. It had previously been running on Jekyll. Both these SSGs ship with the ability to create excerpts from your markdown content in 1 line or thereabouts.

Jekyll

In future, if you want to move from Jekyll to something else, you just have to worry about that `_posts` and `_assets` folder. They may have different naming convention but you can just config-managed it or change it to your choice. This is why I suggested owning that two yourself.

You also may not worry about FrontMatter[3] (meta in the header) and its accompanying jazz by asking Jekyll to use the plugins `jekyll-optional-front-matter` and `jekyll-titles-from-headings`. These comes as part of the officially supported Jekyll plugins[4] by Github. That way, you are just writing a human-readable plain-text spiced up with Markdown and readable by almost every other Static Site Generator.

Now, play with the `_config.yml` that Jekyll generates for you from the theme above to define your post dates, navigation, and others. Jekyll is one of the OGs — the Gandalf of Static Site Generators. If you have a problem, someone somewhere has solved that.

Did I missed something? I was supposed to write a blog article for my website on this one and this comment will serve as my starting bullet points.

1. https://docs.github.com/en/pages/setting-up-a-github-pages-s...

2. https://jekyllrb.com

3. https://frontmatter.codes/docs/markdown

4. https://docs.github.com/en/pages/setting-up-a-github-pages-s...

"Using the Chirpy theme for Jekyll."

I would suggest looking into static site generators. Some popular examples, which are used myself are: - Hugo: https://gohugo.io/ - Jekyll: https://jekyllrb.com

In terms of GitHub stars, SSGs like Next.js, Hugo, Gatsby, Docusaurus, Nuxt.js, and Jekyll top the list. Some popular SSGs even host conferences and workshops, providing resources and networking opportunities for those looking to explore more advanced topics in depth.

I created my blog using Jekyll, a great open-source tool that can transform your markdown content into a simple, old-fashioned-but-trendy, static site. What are the advantages of this approach? The site is super-light, super-fast, super-secure and SEO-friendly. Of course, it’s not always the best solution, but for some use cases, like a simple personal blog, it’s really a good option.

Yes, it's Markdown and I use https://jekyllrb.com with the theme "jekyll-theme-hacker" to generate the site. I quite like how simple it is.