Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

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.

Files for pyMd2Doc, version 2.0.2
Filename, size File type Python version Upload date Hashes
Filename, size pyMd2Doc-2.0.2-py3-none-any.whl (33.3 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size pyMd2Doc-2.0.2.tar.gz (32.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page