https://github.com/plumed/plumedmarkdown
https://github.com/plumed/plumedmarkdown
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/plumed/plumedmarkdown
- Owner: plumed
- License: lgpl-2.1
- Created: 2021-08-14T11:02:32.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-07-13T17:27:13.000Z (almost 3 years ago)
- Last Synced: 2025-01-02T00:42:02.938Z (5 months ago)
- Language: Python
- Size: 23.4 KB
- Stars: 0
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PlumedMarkdown
This extension adds PLUMED input file support to [Python-Markdown](https://github.com/Python-Markdown/markdown)
## Documentation
You can install this using the command:
````
pip install PlumedMarkdown
````
You can include PLUMED input files in your markdown files between `\plumedfile` and `\endplumedfile` as shown below:
````
\plumedfile
d1: DISTANCE ATOMS=1,2
PRINT ARG=d1 FILE=colvar
\endplumedfile
````
When you convert the resulting file to HTML using markdown you can then use a python script something like this:
````
import markdown
from PlumedMarkdown import PlumedExtension
markdown.markdownFromFile( input="myfile.md", extensions[PlumedExtension()], )
````