# markdown-up
[](https://pypi.org/project/markdown-up/)
[](https://pypi.org/project/markdown-up/)
[](https://github.com/craigahobbs/markdown-up-py/blob/main/LICENSE)
[](https://pypi.org/project/markdown-up/)
MarkdownUp is a Markdown viewer.
## Install MarkdownUp
Use Python's `pip` to install MarkdownUp as follows:
~~~
pip install markdown-up
~~~
## View Markdown Files
To start MarkdownUp, open a terminal and run the `markdown-up` application:
~~~
markdown-up
~~~
The `markdown-up` application opens the web browser to the MarkdownUp file browser, which allows you
to view Markdown or HTML files and navigate directories. To view a file, click on its link.
You can view a specific file as follows:
~~~
markdown-up README.md
~~~
**Note:** MarkdownUp runs entirely offline. It does not use an external service to render Markdown
files.
## Running MarkdownUp
When you run the `markdown-up` application, in addition to opening the web browser, it starts a
[chisel](https://pypi.org/project/chisel/)
backend API application using
[waitress](https://pypi.org/project/waitress/).
### Automatic HTML for Markdown Files
When you run MarkdownUp and click on a Markdown file link, the link navigates to an HTML file that
renders the Markdown file. Every Markdown file hosted by MarkdownUp has a corresponding `.html` file
of the same name. For example, if you run Markdown up in a directory that has the following Markdown
files: "README.md" and "CHANGELOG.md". The MarkdownUp service automatically generates "README.html"
and "CHANGELOG.html" files.
The generated `.html` files are HTML stubs for the
[MarkdownUp Front-End Application](https://github.com/craigahobbs/markdown-up#readme).
All Markdown parsing and rendering are done on the client to minimize server costs.
### Command-Line Arguments
The `markdown-up` application has the following command-line arguments:
```
usage: markdown-up [-h] [-p N] [-t N] [-n] [-r] [-q] [path]
positional arguments:
path the file or directory to view (default is ".")
options:
-h, --help show this help message and exit
-p N the application port (default is 8080)
-t N the number of web server threads (default is 8)
-n don't open a web browser
-r release mode (cache statics, remove documentation and index)
-q don't display access logging
```
## MarkdownUp Applications
[MarkdownUp Applications](https://github.com/craigahobbs/markdown-up?tab=readme-ov-file#dynamic-markdown-applications)
are front-end applications that run within the
[MarkdownUp Front-End Application](https://github.com/craigahobbs/markdown-up#readme)
using the
[BareScript](https://github.com/craigahobbs/bare-script#readme)
programming language. Markdown files viewed within MarkdownUp may contain `markdown-script` fenced
code blocks containing
[BareScript](https://github.com/craigahobbs/bare-script#readme)
that execute when the Markdown renders.
MarkdownUp has libraries for dynamically generating and rendering Markdown text, drawing SVG images,
performing data analytics, parsing application arguments, and much more. See the
[MarkdownUp Library](https://craigahobbs.github.io/markdown-up/library/)
and
[MarkdownUp Include Library](https://craigahobbs.github.io/markdown-up/library/include.html)
for more information.
Here's an example of a simple MarkdownUp application:
~~~markdown
# The First Ten Numbers
Here are the first ten numbers:
```markdown-script
i = 1
while i <= 10:
markdownPrint('', stringNew(i))
i = i + 1
endwhile
```
~~~
### MarkdownUp Application Examples
To see what's possible with MarkdownUp Applications, see the
[MarkdownUp Application Examples](https://craigahobbs.github.io/#var.vPage='MarkdownUp')
page.
## Development
This package is developed using [python-build](https://github.com/craigahobbs/python-build#readme).
It was started using [python-template](https://github.com/craigahobbs/python-template#readme) as follows:
~~~
template-specialize python-template/template/ markdown-up-py/ -k package markdown-up -k name 'Craig A. Hobbs' -k email 'craigahobbs@gmail.com' -k github 'craigahobbs' -k noapi 1
~~~
Raw data
{
"_id": null,
"home_page": "https://github.com/craigahobbs/markdown-up-py",
"name": "markdown-up",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Markdown, viewer",
"author": "Craig A. Hobbs",
"author_email": "craigahobbs@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c9/13/e169c7d441b85f69f202a1d8465fcdfd57a7fb938f58cecc8171f0fbc402/markdown_up-2.2.1.tar.gz",
"platform": null,
"description": "# markdown-up\n\n[](https://pypi.org/project/markdown-up/)\n[](https://pypi.org/project/markdown-up/)\n[](https://github.com/craigahobbs/markdown-up-py/blob/main/LICENSE)\n[](https://pypi.org/project/markdown-up/)\n\nMarkdownUp is a Markdown viewer.\n\n\n## Install MarkdownUp\n\nUse Python's `pip` to install MarkdownUp as follows:\n\n~~~\npip install markdown-up\n~~~\n\n\n## View Markdown Files\n\nTo start MarkdownUp, open a terminal and run the `markdown-up` application:\n\n~~~\nmarkdown-up\n~~~\n\nThe `markdown-up` application opens the web browser to the MarkdownUp file browser, which allows you\nto view Markdown or HTML files and navigate directories. To view a file, click on its link.\n\nYou can view a specific file as follows:\n\n~~~\nmarkdown-up README.md\n~~~\n\n**Note:** MarkdownUp runs entirely offline. It does not use an external service to render Markdown\nfiles.\n\n\n## Running MarkdownUp\n\nWhen you run the `markdown-up` application, in addition to opening the web browser, it starts a\n[chisel](https://pypi.org/project/chisel/)\nbackend API application using\n[waitress](https://pypi.org/project/waitress/).\n\n\n### Automatic HTML for Markdown Files\n\nWhen you run MarkdownUp and click on a Markdown file link, the link navigates to an HTML file that\nrenders the Markdown file. Every Markdown file hosted by MarkdownUp has a corresponding `.html` file\nof the same name. For example, if you run Markdown up in a directory that has the following Markdown\nfiles: \"README.md\" and \"CHANGELOG.md\". The MarkdownUp service automatically generates \"README.html\"\nand \"CHANGELOG.html\" files.\n\nThe generated `.html` files are HTML stubs for the\n[MarkdownUp Front-End Application](https://github.com/craigahobbs/markdown-up#readme).\nAll Markdown parsing and rendering are done on the client to minimize server costs.\n\n\n### Command-Line Arguments\n\nThe `markdown-up` application has the following command-line arguments:\n\n```\nusage: markdown-up [-h] [-p N] [-t N] [-n] [-r] [-q] [path]\n\npositional arguments:\n path the file or directory to view (default is \".\")\n\noptions:\n -h, --help show this help message and exit\n -p N the application port (default is 8080)\n -t N the number of web server threads (default is 8)\n -n don't open a web browser\n -r release mode (cache statics, remove documentation and index)\n -q don't display access logging\n```\n\n\n## MarkdownUp Applications\n\n[MarkdownUp Applications](https://github.com/craigahobbs/markdown-up?tab=readme-ov-file#dynamic-markdown-applications)\nare front-end applications that run within the\n[MarkdownUp Front-End Application](https://github.com/craigahobbs/markdown-up#readme)\nusing the\n[BareScript](https://github.com/craigahobbs/bare-script#readme)\nprogramming language. Markdown files viewed within MarkdownUp may contain `markdown-script` fenced\ncode blocks containing\n[BareScript](https://github.com/craigahobbs/bare-script#readme)\nthat execute when the Markdown renders.\n\nMarkdownUp has libraries for dynamically generating and rendering Markdown text, drawing SVG images,\nperforming data analytics, parsing application arguments, and much more. See the\n[MarkdownUp Library](https://craigahobbs.github.io/markdown-up/library/)\nand\n[MarkdownUp Include Library](https://craigahobbs.github.io/markdown-up/library/include.html)\nfor more information.\n\nHere's an example of a simple MarkdownUp application:\n\n~~~markdown\n# The First Ten Numbers\n\nHere are the first ten numbers:\n\n```markdown-script\ni = 1\nwhile i <= 10:\n markdownPrint('', stringNew(i))\n i = i + 1\nendwhile\n```\n~~~\n\n\n### MarkdownUp Application Examples\n\nTo see what's possible with MarkdownUp Applications, see the\n[MarkdownUp Application Examples](https://craigahobbs.github.io/#var.vPage='MarkdownUp')\npage.\n\n\n## Development\n\nThis package is developed using [python-build](https://github.com/craigahobbs/python-build#readme).\nIt was started using [python-template](https://github.com/craigahobbs/python-template#readme) as follows:\n\n~~~\ntemplate-specialize python-template/template/ markdown-up-py/ -k package markdown-up -k name 'Craig A. Hobbs' -k email 'craigahobbs@gmail.com' -k github 'craigahobbs' -k noapi 1\n~~~\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "The MarkdownUp launcher",
"version": "2.2.1",
"project_urls": {
"Homepage": "https://github.com/craigahobbs/markdown-up-py"
},
"split_keywords": [
"markdown",
" viewer"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "fa2a59e23fd73efb6c1fb6712780a30c17b7730b03aa09078d68e995b342b2ae",
"md5": "89ddd978d0f02af6db0ab4a1dcfe9c83",
"sha256": "c8e719317a15e4c73de21fd8e1d3d96c213d08d2b295fb7aa5d4dcfe0b56b8dd"
},
"downloads": -1,
"filename": "markdown_up-2.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "89ddd978d0f02af6db0ab4a1dcfe9c83",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10860,
"upload_time": "2025-07-19T16:13:54",
"upload_time_iso_8601": "2025-07-19T16:13:54.736810Z",
"url": "https://files.pythonhosted.org/packages/fa/2a/59e23fd73efb6c1fb6712780a30c17b7730b03aa09078d68e995b342b2ae/markdown_up-2.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c913e169c7d441b85f69f202a1d8465fcdfd57a7fb938f58cecc8171f0fbc402",
"md5": "7cab1dd93f3352afc64fde49de867152",
"sha256": "77392f811279cfe5610280220db2828dc7eba9b032df14459341960690f6cbb2"
},
"downloads": -1,
"filename": "markdown_up-2.2.1.tar.gz",
"has_sig": false,
"md5_digest": "7cab1dd93f3352afc64fde49de867152",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10270,
"upload_time": "2025-07-19T16:13:56",
"upload_time_iso_8601": "2025-07-19T16:13:56.030609Z",
"url": "https://files.pythonhosted.org/packages/c9/13/e169c7d441b85f69f202a1d8465fcdfd57a7fb938f58cecc8171f0fbc402/markdown_up-2.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-19 16:13:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "craigahobbs",
"github_project": "markdown-up-py",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "markdown-up"
}
JSON
