Skip to content

Syrup/markdown-it-template

Repository files navigation

How to Use

Well... it's not finished yet but ready to use.

I will show you how to create a new page

open views/markdown and create new file with format .md.

WARNING: do not use special characters when naming files.

Open a new file and fill it with markdown

Example:

---
title: Your Title
---

# Hello World
> Blockquote
[Link](https://markdownitapp.mioun.repl.co/)

Now check by going to the url http://your-web.com/article/filename.

You can also custom css in public/style.css.

Check config.toml file for global configuration

and frontmatter for inpage configuration.

Example open https://markdownitapp.mioun.repl.co/example.

To run server use

bash main.sh

instead of

npm start

if it's the first time.

And then, you can add anything you want like navbar :)


That's all for now.

Footer

TODO:

  1. Create a routing system
  2. Reach 10★ on Github

Github

CREDITS:

  1. markdown-it
  2. markdown-it-task-lists
  3. highlight.js
  4. front-matter
  5. mustache