MarkdownPages.CLI 0.1.0

A CLI tool to render markdown.

dotnet tool install --global MarkdownPages.CLI --version 0.1.0
This package contains a .NET Core Global Tool you can call from the shell/command line.

Markdown Pages






  • Author: Stardust D.L.
  • Version: 0.1

A CLI tool to render markdown (use Markdig inside).

Introduction

How mdp come:
I like to take notes in markdown, but it's not really convient to build pages for many files.
So I make this tool to do that.

You can use mdp to:

  • Render your markdown documents to static pages in the directory
  • Run a server to host the static pages

Install

When .NET Core 2.1 is released, I will add this as a global tool.

Use .NET Core 2.1

$ dotnet tool install -g MarkdownPages.CLI

Usage

You can use mdp help to get helps and mdp version to show the version.

Initialize

Initialize the mdp repository or reinitialize it.

When you update mdp, please use this command to update associated files. For next version, I may add a new command migrate to do this.

$ mdp init

Create a new document

Create a new document.

$ mdp new <file name>

The new document will be create in the root directory, the file name will be the title of the document.
If you use a path for file name, then mdp will create sub-directories,
and use the path for the category of the document.

Build

Build all markdown documents.
The builed files will at .mdp/build/

$ mdp build

Serve

Run a server to host the static pages.

The host uri is http://localhost:16000

$ mdp serve

Files

Document

For every document, the head lines will be like this:

---
author: author
category: category1/category2
tags: tag1,tag2
title: title
---

Config

The config file is at .mdp/config.yaml.

# default author
author: null

Template

The template file for document render is at .mdp/render/page.html.

The built-in yield list:

|Yield|Text in Template|
|-|-|
|Title|{title}|
|Author|{copyright.author}|
|Rendered document content|{content}|

Markdown Support

Dependencies

License

LGPLv3

Markdown Pages






  • Author: Stardust D.L.
  • Version: 0.1

A CLI tool to render markdown (use Markdig inside).

Introduction

How mdp come:
I like to take notes in markdown, but it's not really convient to build pages for many files.
So I make this tool to do that.

You can use mdp to:

  • Render your markdown documents to static pages in the directory
  • Run a server to host the static pages

Install

When .NET Core 2.1 is released, I will add this as a global tool.

Use .NET Core 2.1

$ dotnet tool install -g MarkdownPages.CLI

Usage

You can use mdp help to get helps and mdp version to show the version.

Initialize

Initialize the mdp repository or reinitialize it.

When you update mdp, please use this command to update associated files. For next version, I may add a new command migrate to do this.

$ mdp init

Create a new document

Create a new document.

$ mdp new <file name>

The new document will be create in the root directory, the file name will be the title of the document.
If you use a path for file name, then mdp will create sub-directories,
and use the path for the category of the document.

Build

Build all markdown documents.
The builed files will at .mdp/build/

$ mdp build

Serve

Run a server to host the static pages.

The host uri is http://localhost:16000

$ mdp serve

Files

Document

For every document, the head lines will be like this:

---
author: author
category: category1/category2
tags: tag1,tag2
title: title
---

Config

The config file is at .mdp/config.yaml.

# default author
author: null

Template

The template file for document render is at .mdp/render/page.html.

The built-in yield list:

|Yield|Text in Template|
|-|-|
|Title|{title}|
|Author|{copyright.author}|
|Rendered document content|{content}|

Markdown Support

Dependencies

License

LGPLv3

  • .NETCoreApp 2.1

    • No dependencies.

Version History

Version Downloads Last updated
0.1.0 296 5/10/2018