Skip to content

Latest commit

 

History

History
41 lines (24 loc) · 955 Bytes

howtouse.md

File metadata and controls

41 lines (24 loc) · 955 Bytes

How to use

Also accessed with relative path

Template

Template for server available at https://github.com/wmartinmimi/md.html-template.

Just put your README.md and other .md in.

Quick deploy

In your server root:

curl https://raw.githubusercontent.com/wmartinmimi/md.html/main/md.html -o index.html

Done!

Important

If your server automatically convert markdowns to htmls and deletes markdowns, you may need to disable the function.

How to access

If you placed md.html as index.html in your server root:

  1. Open <insert domain here> in browser
  2. Done!

If you want to access other markdown files than index.md or README.md, there are 2 options:

  • Add links to them in index.md/README.md
  • <insert domain>/index.html?path=<absolute path to md>

Example: