# 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": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "markdown html documentation",
"author": "Vincent Fabre",
"author_email": "peigne.plume@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a4/e7/84b177e5ed1c56d228c362dfa99cba1ca2800f5284ee47d2b7290a2bc8bb/madoc-1.1.10.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\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Documentation generator from markdown files",
"version": "1.1.10",
"project_urls": {
"Homepage": "https://github.com/byoso/madoc"
},
"split_keywords": [
"markdown",
"html",
"documentation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2b9bdb2aa9e3a3c4cf058cfcb0a7b7bd65d7ab959c91730c652ac8a74ae65520",
"md5": "5527c866c5db482d0066d00b2813d1c1",
"sha256": "deb01a42c4af40773f6fc682636530c5e76da480ece2fd9e5f60690f4b938ff7"
},
"downloads": -1,
"filename": "madoc-1.1.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5527c866c5db482d0066d00b2813d1c1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 23597,
"upload_time": "2024-02-26T18:18:28",
"upload_time_iso_8601": "2024-02-26T18:18:28.403933Z",
"url": "https://files.pythonhosted.org/packages/2b/9b/db2aa9e3a3c4cf058cfcb0a7b7bd65d7ab959c91730c652ac8a74ae65520/madoc-1.1.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a4e784b177e5ed1c56d228c362dfa99cba1ca2800f5284ee47d2b7290a2bc8bb",
"md5": "eade59ff29d6d9f6e23f8d7b541169e7",
"sha256": "7731e04e22eb128f516d1632af9f24c3a7a70a9375bf302b376aa9bd3d33c401"
},
"downloads": -1,
"filename": "madoc-1.1.10.tar.gz",
"has_sig": false,
"md5_digest": "eade59ff29d6d9f6e23f8d7b541169e7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 18561,
"upload_time": "2024-02-26T18:18:30",
"upload_time_iso_8601": "2024-02-26T18:18:30.534472Z",
"url": "https://files.pythonhosted.org/packages/a4/e7/84b177e5ed1c56d228c362dfa99cba1ca2800f5284ee47d2b7290a2bc8bb/madoc-1.1.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-26 18:18:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "byoso",
"github_project": "madoc",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "madoc"
}
JSON
