# MyST Markdown Command Line Interface, `mystmd`
[](https://github.com/executablebooks/mystmd/blob/main/LICENSE)
`mystmd` is a set of open-source, community-driven tools designed for scientific communication, including a powerful authoring framework that supports blogs, online books, scientific papers, reports and journals articles.
> **Note**
> The `mystmd` project is in **beta**. It is being used to explore a full MyST implementation and will change significantly and rapidly.
> The project is being developed by a small team of people on the Executable Books Project, and may make rapid decisions without fully public/inclusive discussion.
> We will continue to update this documentation as the project stabilizes.
## Overview
The `mystmd` project provides a command line tool (`mystmd`) for working with MyST Markdown projects.
- Provides functionality for cross-referencing, external structured links, and scientific citations
- Translate and render MyST Markdown into:
- HTML for static websites, and modern React for interactive websites (like this website!)
- PDFs and LaTeX documents, with specific templates for over 400 journals
- Microsoft Word export
- Parse MyST into a standardized AST, that follows the MyST Markdown Spec
See the [documentation](https://mystmd.org/guide).
## Get Started
The MyST Markdown CLI is available through PyPI:
```bash
pip install mystmd
myst init
myst build my-doc.md --tex
```
and Conda:
```bash
conda config --add channels conda-forge
conda config --set channel_priority strict
conda install mystmd
myst init
myst build my-doc.md --tex
```
Raw data
{
"_id": null,
"home_page": null,
"name": "mystmd",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "latex, markdown, pdf-generation, science-research, scientific-visualization, writing-software",
"author": null,
"author_email": "Rowan Cockett <rowan@curvenote.com>",
"download_url": "https://files.pythonhosted.org/packages/50/6b/0a421cd4cd3c8249d2229c95394b37a223c8a190d0a863a35e4774311a62/mystmd-1.2.0.tar.gz",
"platform": null,
"description": "# MyST Markdown Command Line Interface, `mystmd`\n\n[](https://github.com/executablebooks/mystmd/blob/main/LICENSE)\n\n\n`mystmd` is a set of open-source, community-driven tools designed for scientific communication, including a powerful authoring framework that supports blogs, online books, scientific papers, reports and journals articles.\n\n> **Note**\n> The `mystmd` project is in **beta**. It is being used to explore a full MyST implementation and will change significantly and rapidly.\n> The project is being developed by a small team of people on the Executable Books Project, and may make rapid decisions without fully public/inclusive discussion.\n> We will continue to update this documentation as the project stabilizes.\n\n## Overview\n\nThe `mystmd` project provides a command line tool (`mystmd`) for working with MyST Markdown projects.\n\n- Provides functionality for cross-referencing, external structured links, and scientific citations\n- Translate and render MyST Markdown into:\n - HTML for static websites, and modern React for interactive websites (like this website!)\n - PDFs and LaTeX documents, with specific templates for over 400 journals\n - Microsoft Word export\n- Parse MyST into a standardized AST, that follows the MyST Markdown Spec\n\nSee the [documentation](https://mystmd.org/guide).\n\n## Get Started\n\nThe MyST Markdown CLI is available through PyPI:\n\n```bash\npip install mystmd\nmyst init\nmyst build my-doc.md --tex\n```\n\nand Conda:\n\n```bash\nconda config --add channels conda-forge\nconda config --set channel_priority strict\nconda install mystmd\nmyst init\nmyst build my-doc.md --tex\n```",
"bugtrack_url": null,
"license": null,
"summary": "Command line tools for MyST Markdown",
"version": "1.2.0",
"project_urls": {
"Bug Tracker": "https://github.com/executablebooks/mystmd/issues",
"Homepage": "https://github.com/executablebooks/mystmd",
"Repository": "https://github.com/executablebooks/mystmd.git"
},
"split_keywords": [
"latex",
" markdown",
" pdf-generation",
" science-research",
" scientific-visualization",
" writing-software"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bb3a9abc32f291e3525fcb59312b28d97c30e28da47adebc242f9b6e90401d2c",
"md5": "2c1513af66aeff67572b7cdb847c88d0",
"sha256": "2632f7a3ac3dd3e0d6a392ed308bdda4e970473eb4c598ef2335944851958347"
},
"downloads": -1,
"filename": "mystmd-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2c1513af66aeff67572b7cdb847c88d0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 2549439,
"upload_time": "2024-04-30T14:12:51",
"upload_time_iso_8601": "2024-04-30T14:12:51.695385Z",
"url": "https://files.pythonhosted.org/packages/bb/3a/9abc32f291e3525fcb59312b28d97c30e28da47adebc242f9b6e90401d2c/mystmd-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "506b0a421cd4cd3c8249d2229c95394b37a223c8a190d0a863a35e4774311a62",
"md5": "3de968e30445ebff7c51464e213a68c7",
"sha256": "d0c20992e48658ad4e1e205be937bd7e648552cdc3f676b77009eb28129ab1af"
},
"downloads": -1,
"filename": "mystmd-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "3de968e30445ebff7c51464e213a68c7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 2519979,
"upload_time": "2024-04-30T14:12:54",
"upload_time_iso_8601": "2024-04-30T14:12:54.488889Z",
"url": "https://files.pythonhosted.org/packages/50/6b/0a421cd4cd3c8249d2229c95394b37a223c8a190d0a863a35e4774311a62/mystmd-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-30 14:12:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "executablebooks",
"github_project": "mystmd",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mystmd"
}
JSON
