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.3.0.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

markapp-0.3.0-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for markapp-0.3.0.tar.gz
Algorithm Hash digest
SHA256 86b3d48e17244c5d94562476ab43d4d1c420baf4e31c86102da4c62ccd8e88cf
MD5 d8a03a8545ce15535b88b048674e7cf5
BLAKE2b-256 47e1f9d685c36ccc56f17df92c7196320b81a0c2e287c0d735c284c5d5611588

See more details on using hashes here.

File details

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

File metadata

  • Download URL: markapp-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 5.8 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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 83660927055cbe1b568c489463b5bdcb89189c7bb81480b59349fb8ae8150ef4
MD5 b13705f5dfd3ec03ed096a412c6fc9d9
BLAKE2b-256 2d35d34f08d1f0e2ccaa6805e5d6c0b15fece3d80116e48a1146f5c8d696ff99

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