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 markapp

# 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.1.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: markapp-0.2.1.tar.gz
  • Upload date:
  • Size: 4.8 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.1.tar.gz
Algorithm Hash digest
SHA256 50e579099c0a48b5190c3fa8532b6d1d3afbdac00935858c4296a8a2da151e93
MD5 d40493269d1e52107a6cb4106247a6e5
BLAKE2b-256 c3978fdfb7c0ad7ac0d0c889848fad116f8443b20f72bcd5ee302b56320b3473

See more details on using hashes here.

File details

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

File metadata

  • Download URL: markapp-0.2.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 88d1e9a9aa4b9ac1bae75598e40c13214324388d35ae0cd7115e374a8c9deddd
MD5 c27929606575ae619ab953ae1ff38db6
BLAKE2b-256 2b34d6d98b339b91346737b5e52239fcd3dd6c913d72b0f3eb73ba16ab5857fc

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