tinymdserv

v1.1.1

Published

5 months ago

Tiny Markdown Server

Downloads

0High
0Medium
0Low

doosik71

Tiny Markdown Server

TinyMDServ

TinyMDServ is a lightweight Markdown server designed for rapid deployment of Markdown-based documentation. It allows you to host your Markdown files with minimal configuration and includes simple templating capabilities.

Features

Markdown Rendering: Automatically converts .md files into HTML using marked.js
Custom Templates: Supports custom templates using EJS to style your content
Search Functionality: Basic search template for navigating between different documentation pages
Port Customization: Allows specifying a custom port and document root directory
Cross-Platform Support: Works seamlessly across Windows, macOS, and Linux environments
Math Expression Support: Render mathematical expressions using $ and $$ delimiters
Mermaid Diagrams: Support for Mermaid.js diagram rendering
Auto-Update: Automatic page refresh when files change
SSL/HTTPS Support: Auto-detects SSL certificates and enables HTTPS
Presentation Mode: Pagination support for presentation-style viewing

Installation

Install TinyMDServ globally via npm:
```
npm install -g tinymdserv
```

Usage

Create a Homepage: Create a docs/index.md file as your homepage.
```
# Home

Hello
```

Create Custom Templates: Define templates using EJS for your document pages.

Main Template: docs/template.ejs

<html>
<head>
  <meta charset="utf-8" />
  <meta lang="en" />
  <title><%=title %></title>
</head>
<body>
  <article>
    <%-content %>
  </article>
</body>
</html>

Search Template: docs/search.ejs

<html>
<head>
<meta charset="utf-8" />
<meta lang="en" />
<title><%=title %></title>
</head>
<body>
  <article>
    <ul>
    <% content.forEach(path => { %>
      <li><a href='<%-path %>'><%-path %></a></li>
    <% }) %>
    </ul>
  </article>
</body>
</html>

Run the Server: Start the server by specifying an optional port number and document root path.

Command:
  tinymdserv

Options:
  --version      Show version number                                   [boolean]
  -p, --port     Set port number                   [number] [default: 80/443]
  -d, --dir      Set document path                  [string] [default: "./docs"]
  -f, --file     Set document default name        [string] [default: "index.md"]
  -q, --quiet    Activate quiet mode                                   [boolean]
      --help     Show help                                             [boolean]

Examples

Run on default port (80 for HTTP, 443 for HTTPS):
```
tinymdserv
```
Run on custom port:
```
tinymdserv -p 8080
```
Run with specific document directory:
```
tinymdserv -p 80 -d ./my-docs
```
Run in quiet mode:
```
tinymdserv -q
```
Run using node directly (alternative method):
```
node app.js -p 8080 -d ./docs
```

Release Notes

v1.1.1
- Fix math handling
v1.1.0
- Enhanced UI with modern mint green theme
- Enhanced math rendering
- Update related package version
v1.0.27
- Fix search script.
v1.0.26
- Change command argument syntax. Add quiet mode.
v1.0.25
- Update example page and default style.
v1.0.24
- Fix math expression. Separate '$' and '$$'.
v1.0.23
- Fix math expression escaping for backtick and quote.
v1.0.22
- Fix math expression escaping for backslash and underscore.
v1.0.13
- Add pagination for presentation mode.
v1.0.9
- Add page auto-update.
v1.0.0
- Initial release.

Published

Vulnerabilities

Links

Maintainers

Keywords