madoc

Name	madoc JSON
Version	1.1.12 JSON
	download
home_page	https://github.com/byoso/madoc
Summary	Documentation generator from markdown files
upload_time	2024-10-27 15:42:29
maintainer	None
docs_url	None
author	Vincent Fabre
requires_python	>=3.8
license	MIT
keywords	markdown html documentation
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Madoc


## What is Madoc for ?

It is a terminal tool to automatically generate a single html documentation file from all
the .md files found in the directory.

Cool stuff to join a clean and easy to read documentation to some project.


# Installation

`pip install madoc`


# Usage

Open a terminal in the directory where the .md files are,
and just type:

`madoc`

done, you have your documentation in a single html file.

Know more options with `madoc -h`.


# Changelog

- 1.1.1: responsive design
- 1.1.0: Recursive build mode

# Libraries used by Madoc

- Bulma (CSS framework)
- Vue.js (JS framework)
- Marked (JS library)
- Jinja2 (python library)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/byoso/madoc",
    "name": "madoc",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "markdown html documentation",
    "author": "Vincent Fabre",
    "author_email": "peigne.plume@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/e2/6f/d82ffa11329d452ff649fb0abcac94479d98ec22691b813ecf18f38284ad/madoc-1.1.12.tar.gz",
    "platform": null,
    "description": "# Madoc\n\n\n## What is Madoc for ?\n\nIt is a terminal tool to automatically generate a single html documentation file from all\nthe .md files found in the directory.\n\nCool stuff to join a clean and easy to read documentation to some project.\n\n\n# Installation\n\n`pip install madoc`\n\n\n# Usage\n\nOpen a terminal in the directory where the .md files are,\nand just type:\n\n`madoc`\n\ndone, you have your documentation in a single html file.\n\nKnow more options with `madoc -h`.\n\n\n# Changelog\n\n- 1.1.1: responsive design\n- 1.1.0: Recursive build mode\n\n# Libraries used by Madoc\n\n- Bulma (CSS framework)\n- Vue.js (JS framework)\n- Marked (JS library)\n- Jinja2 (python library)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Documentation generator from markdown files",
    "version": "1.1.12",
    "project_urls": {
        "Homepage": "https://github.com/byoso/madoc"
    },
    "split_keywords": [
        "markdown",
        "html",
        "documentation"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cd96fdaa562ae6e3cc784cbd749e286e07a1084b83228866e35cb6713a4ec2de",
                "md5": "f3387c88df208511283e39a5107710f6",
                "sha256": "8cf4fd159c9a35d1585789fe167574d8d1519ce8f6e434aedd9c2671e88dcbc5"
            },
            "downloads": -1,
            "filename": "madoc-1.1.12-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f3387c88df208511283e39a5107710f6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 23717,
            "upload_time": "2024-10-27T15:42:28",
            "upload_time_iso_8601": "2024-10-27T15:42:28.069813Z",
            "url": "https://files.pythonhosted.org/packages/cd/96/fdaa562ae6e3cc784cbd749e286e07a1084b83228866e35cb6713a4ec2de/madoc-1.1.12-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e26fd82ffa11329d452ff649fb0abcac94479d98ec22691b813ecf18f38284ad",
                "md5": "d857ee7a542743856c485b16d47debff",
                "sha256": "1013f8ca15445d96f59550ee108cd934ab61d39cb90597c42935b6ec9bf9a061"
            },
            "downloads": -1,
            "filename": "madoc-1.1.12.tar.gz",
            "has_sig": false,
            "md5_digest": "d857ee7a542743856c485b16d47debff",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 18781,
            "upload_time": "2024-10-27T15:42:29",
            "upload_time_iso_8601": "2024-10-27T15:42:29.303728Z",
            "url": "https://files.pythonhosted.org/packages/e2/6f/d82ffa11329d452ff649fb0abcac94479d98ec22691b813ecf18f38284ad/madoc-1.1.12.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-27 15:42:29",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "byoso",
    "github_project": "madoc",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "madoc"
}