https://github.com/brianlesko/render-markdown-html-js

Turn a markdown document into an html web page. Useful for quickly launching simple web pages that can quickly scale up by using html within the markdown document.
https://github.com/brianlesko/render-markdown-html-js

html internet javascript markdown webpage website

Last synced: about 20 hours ago
JSON representation

Turn a markdown document into an html web page. Useful for quickly launching simple web pages that can quickly scale up by using html within the markdown document.

• Host: GitHub
• URL: https://github.com/brianlesko/render-markdown-html-js
• Owner: BrianLesko
• Created: 2024-07-06T14:35:12.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-08-24T17:26:57.000Z (3 months ago)
• Last Synced: 2024-08-24T18:54:28.297Z (3 months ago)
• Topics: html, internet, javascript, markdown, webpage, website
• Language: CSS
• Homepage:
• Size: 5.86 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        

# Render markdown documents as an HTML web page

Use this minimal viable code to render a markdown document as a web page. This is advantageous over using HTML alone becaue of markdown's simplicity, which is much easier to maintain and edit. Written in html, css, and minimal javascript.

 

## Languages / tools

This code uses the following libraries:

- `html`: for packaging the css styles and javascript code together

- `css`: to format the style of the page

- `javascript`: to take the markdown document and turn it into the html webpage

 

## Setup

a simple file server will work, for example, if your system has python installed and a web connection, simply run an http server to deploy locally.

```python

python3 -m http.server

```

If you intent to deploy publically and self host, I would reccomend using Caddy Server. Its super easy to get set up compared to Nginx or Apache, and it automatically handles ssl certificates, serving the page over https by default.

 

## About

I wrote this code to make creating a website easier. 

 



 



╭━━╮╭━━━┳━━┳━━━┳━╮╱╭╮        ╭╮╱╱╭━━━┳━━━┳╮╭━┳━━━╮

┃╭╮┃┃╭━╮┣┫┣┫╭━╮┃┃╰╮┃┃        ┃┃╱╱┃╭━━┫╭━╮┃┃┃╭┫╭━╮┃

┃╰╯╰┫╰━╯┃┃┃┃┃╱┃┃╭╮╰╯┃        ┃┃╱╱┃╰━━┫╰━━┫╰╯╯┃┃╱┃┃

┃╭━╮┃╭╮╭╯┃┃┃╰━╯┃┃╰╮┃┃        ┃┃╱╭┫╭━━┻━━╮┃╭╮┃┃┃╱┃┃

┃╰━╯┃┃┃╰┳┫┣┫╭━╮┃┃╱┃┃┃        ┃╰━╯┃╰━━┫╰━╯┃┃┃╰┫╰━╯┃

╰━━━┻╯╰━┻━━┻╯╱╰┻╯╱╰━╯        ╰━━━┻━━━┻━━━┻╯╰━┻━━━╯

  

 

                          

follow all of these for pizza :)