lamarkdown


Namelamarkdown JSON
Version 0.10.1 PyPI version JSON
download
home_pagehttps://github.com/lamarkdown/lamarkdown
SummaryA tool for compiling markdown files into standalone HTML documents, using Python Markdown. Supports Latex (given an existing Tex distribution), custom CSS and JavaScript, multiple document variations from a single source file, and a live output view.
upload_time2024-03-05 12:17:09
maintainer
docs_urlNone
authorDavid J A Cooper
requires_python>=3.8,<4.0
licenseMIT
keywords markdown
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Lamarkdown

Lamarkdown is a command-line document preparation system based on [Python-Markdown][]. It attempts to address similar use cases to LaTeX, but using the Markdown and HTML formats. It is _not_ directly intended to build static websites, though its extensions can be reused in [MkDocs][] (or in other applications based on Python-Markdown).

Take the [Lamarkdown tour][] to get a first impression.


## Requirements and Installation

Lamarkdown depends on Python 3.8+. To install via pip:

```console
$ pip install lamarkdown
```


## Basic Usage

To compile `mydocument.md` into `mydocument.html`, run:

```console
$ lamd mydocument.md
```

To enable the live-update mode, use `-l`/`--live`:

```console
$ lamd -l mydocument.md
```

This will launch a local web-server and a web-browser, and will keep `mydocument.html` in sync with any changes made to `mydocument.md`, until you press Ctrl+C in the terminal.


## Full Documentation

See the full documentation at [lamarkdown.github.io](https://lamarkdown.github.io).


[Lamarkdown tour]: https://lamarkdown.github.io/tour
[MkDocs]: https://www.mkdocs.org/
[Python-Markdown]: https://python-markdown.github.io

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/lamarkdown/lamarkdown",
    "name": "lamarkdown",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<4.0",
    "maintainer_email": "",
    "keywords": "markdown",
    "author": "David J A Cooper",
    "author_email": "david.cooper+pypi@djac.au",
    "download_url": "https://files.pythonhosted.org/packages/9f/b4/b225e8bb79a769512f5fdaaf93fea978467f95039946eea5026b8b1cd8e9/lamarkdown-0.10.1.tar.gz",
    "platform": null,
    "description": "# Lamarkdown\n\nLamarkdown is a command-line document preparation system based on [Python-Markdown][]. It attempts to address similar use cases to LaTeX, but using the Markdown and HTML formats. It is _not_ directly intended to build static websites, though its extensions can be reused in [MkDocs][] (or in other applications based on Python-Markdown).\n\nTake the [Lamarkdown tour][] to get a first impression.\n\n\n## Requirements and Installation\n\nLamarkdown depends on Python 3.8+. To install via pip:\n\n```console\n$ pip install lamarkdown\n```\n\n\n## Basic Usage\n\nTo compile `mydocument.md` into `mydocument.html`, run:\n\n```console\n$ lamd mydocument.md\n```\n\nTo enable the live-update mode, use `-l`/`--live`:\n\n```console\n$ lamd -l mydocument.md\n```\n\nThis will launch a local web-server and a web-browser, and will keep `mydocument.html` in sync with any changes made to `mydocument.md`, until you press Ctrl+C in the terminal.\n\n\n## Full Documentation\n\nSee the full documentation at [lamarkdown.github.io](https://lamarkdown.github.io).\n\n\n[Lamarkdown tour]: https://lamarkdown.github.io/tour\n[MkDocs]: https://www.mkdocs.org/\n[Python-Markdown]: https://python-markdown.github.io\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A tool for compiling markdown files into standalone HTML documents, using Python Markdown. Supports Latex (given an existing Tex distribution), custom CSS and JavaScript, multiple document variations from a single source file, and a live output view.",
    "version": "0.10.1",
    "project_urls": {
        "Documentation": "https://lamarkdown.github.io",
        "Homepage": "https://github.com/lamarkdown/lamarkdown",
        "Repository": "https://github.com/lamarkdown/lamarkdown"
    },
    "split_keywords": [
        "markdown"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "eaf1ee6d70ca9c187bc94f713d3ea4b0646842000e312c99ff63a0639f4029a5",
                "md5": "805e2fbe37a9a9825c9eb8bc18a385a6",
                "sha256": "1599da5641c6c16dc5fc75640ed2526906db9b1aadc59c3fcde456ea0690f81f"
            },
            "downloads": -1,
            "filename": "lamarkdown-0.10.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "805e2fbe37a9a9825c9eb8bc18a385a6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<4.0",
            "size": 105267,
            "upload_time": "2024-03-05T12:17:07",
            "upload_time_iso_8601": "2024-03-05T12:17:07.775353Z",
            "url": "https://files.pythonhosted.org/packages/ea/f1/ee6d70ca9c187bc94f713d3ea4b0646842000e312c99ff63a0639f4029a5/lamarkdown-0.10.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9fb4b225e8bb79a769512f5fdaaf93fea978467f95039946eea5026b8b1cd8e9",
                "md5": "ae3180ab19ae2075a2fb744a04a2c68f",
                "sha256": "786f9f2be6dcd902220aa6700560baa32aa63f4f3eabc8147b07380745c4a09c"
            },
            "downloads": -1,
            "filename": "lamarkdown-0.10.1.tar.gz",
            "has_sig": false,
            "md5_digest": "ae3180ab19ae2075a2fb744a04a2c68f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<4.0",
            "size": 90398,
            "upload_time": "2024-03-05T12:17:09",
            "upload_time_iso_8601": "2024-03-05T12:17:09.850444Z",
            "url": "https://files.pythonhosted.org/packages/9f/b4/b225e8bb79a769512f5fdaaf93fea978467f95039946eea5026b8b1cd8e9/lamarkdown-0.10.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-05 12:17:09",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "lamarkdown",
    "github_project": "lamarkdown",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "tox": true,
    "lcname": "lamarkdown"
}
        
Elapsed time: 0.20365s