Skip to main content

A simple markdown to HTML compiler

Project description

Markapp

Generates index.html, style.css, and script.js from code blocks in Markdown files.

Generative AI is all the rage, but it can be cumbersome to try out code that it generates. This script allows us to manages notes and code snippets in a single file and break them up into multiple files for easy web serving.

Example Usage

pip install https://github.com/ddrscott/markapp.get

# Get list of options
markapp --help

#   Usage: markapp [OPTIONS] SRC
#   
#     Compile markdown files into HTML
#   
#   Options:
#     --output-dir TEXT   Output directory
#     --watch             Watch for changes and recompile
#     --debounce INTEGER  Debounce time in milliseconds
#     --serve             Serve the output directory
#     --host TEXT         Serve host
#     --port INTEGER      Serve port
#     --help              Show this message and exit.
#     Compile markdown files into HTML

markapp tests/sample.md --output-dir .

# Will generate `sample` directory with the following structure:
tree sample
#  sample
#  ├── index.html
#  ├── script.js
#  └── style.css

Sample Markdown

# Really Cool Prompt

Make me a website with html, css, and javascript in their own files.

```html
inner html
```

```css
inner css
```

```javascript
inner javascript
```

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

markapp-0.2.0.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

markapp-0.2.0-py3-none-any.whl (5.4 kB view details)

Uploaded Python 3

File details

Details for the file markapp-0.2.0.tar.gz.

File metadata

  • Download URL: markapp-0.2.0.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.8

File hashes

Hashes for markapp-0.2.0.tar.gz
Algorithm Hash digest
SHA256 b06db313a35ecf21035c406c2070a9aa4680d5a8422e7a21569c6d7799833bb5
MD5 1f657d747b54810ffe2a7e453c2ef9b9
BLAKE2b-256 13b2ac66671a9822df40391504c1216c2862fe080e0f302859b24b6080abc39a

See more details on using hashes here.

File details

Details for the file markapp-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: markapp-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 5.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.8

File hashes

Hashes for markapp-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0301572f7e1ea10b786a845e2d28e98ba40165530759c1b3b2bcb8986ab735b1
MD5 635eb0cb7bd54f4156ae100dd6fd7f12
BLAKE2b-256 0d6bd88880963eba2fa58fefaea9b4f17b0ad77be92d9ab138a220e8f27029a7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page