An open API service indexing awesome lists of open source software.

https://github.com/syrup/markdown-it-template

create blog with markdown using markdown-it
https://github.com/syrup/markdown-it-template

markdown markdown-it markdown-it-app markdown-it-example markdown-it-template markdown-to-html markdown-website markdownitapp

Last synced: 2 months ago
JSON representation

create blog with markdown using markdown-it

Awesome Lists containing this project

README

        

# 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:
```md
---
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](https://markdownitapp.mioun.repl.co/example).

To run server use
```bash
bash main.sh
```

instead of

```bash
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. [x] Create a routing system
> 2. [ ] Reach 10★ on Github

Github

> CREDITS:
> 1. [markdown-it](https://github.com/markdown-it/markdown-it)
> 2. [markdown-it-task-lists](https://github.com/revin/markdown-it-task-lists)
> 3. [highlight.js](https://github.com/highlightjs/highlight.js/)
> 4. [front-matter](https://github.com/jxson/front-matter)
> 5. [mustache](https://github.com/janl/mustache.js)