Skip to main content

fix bug

Project description

# 1.Introduction to pyMd2Doc

Use python to convert markdown to a directory document with retractable text content.

# 2. Method of use

This program requires a python environment of python3 or above.

## 2.1 Prepare Markdown file

Prepare the Markdown file that needs to be converted into a document.

## 2.2 Install pyMd2Doc

Install the program using

pip install pyMd2Doc

## 2.3 Start the conversion

### 2.3.1 md file to HTML

> creates [yourFileName].py file to prepare the markdown file that needs to be converted, such as mymarkdown.md

> introduces the required module, calls the function and passes in the markdown file to be converted, as shown in the following example:

from pymd2doc import createDoc

createDoc.create(“myMarkdown”)

The successful execution of > will generate the mymarkdown.html file

### 2.3.2 String md content to HTML

> introduces the required module, calls the function, and passes in the markdown file that needs to be converted

> passes in String md content, as shown in the following example:

from pymd2doc import createDoc

STR = u’’’

Here is the String md content ‘’’

# param strs passes in the MD string # param myMarkdown definition will generate the name of the HTML file # return myMarkdown.html

createDoc.createByString(strs, “myMarkdown”)

> The successful execution of > will generate the mymarkdown.html file

## 2.4 Check the documentation

Open the mymarkdown.html file you just generated with your browser.

Click the directory to jump to the corresponding document content.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyMd2Doc-2.0.2.tar.gz (32.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyMd2Doc-2.0.2-py3-none-any.whl (33.3 kB view details)

Uploaded Python 3

File details

Details for the file pyMd2Doc-2.0.2.tar.gz.

File metadata

  • Download URL: pyMd2Doc-2.0.2.tar.gz
  • Upload date:
  • Size: 32.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/36.2.7 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.5.2

File hashes

Hashes for pyMd2Doc-2.0.2.tar.gz
Algorithm Hash digest
SHA256 f01c839645459e82788e37b3d6097db9c363847992ae78af07beac399aa7bb59
MD5 927c7a09f3e28b9765d80bafde0afd4c
BLAKE2b-256 d7e6b66a847e34866c2b8eb8a64b6fb0f2a4fc791e7738a034a72f18a8ba3ff2

See more details on using hashes here.

File details

Details for the file pyMd2Doc-2.0.2-py3-none-any.whl.

File metadata

  • Download URL: pyMd2Doc-2.0.2-py3-none-any.whl
  • Upload date:
  • Size: 33.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/36.2.7 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.5.2

File hashes

Hashes for pyMd2Doc-2.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8e399345c9107c8a0d62687637ae88dbe21650dd722e049adbf1526a85574868
MD5 13f8d7e9f38646ff733e585c5a6706b3
BLAKE2b-256 2a91052b71c1148afe21d7486685a80dded8ea925f301010b399f04803859679

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page