Skip to content

Latest commit

 

History

History
79 lines (54 loc) · 4.19 KB

README.md

File metadata and controls

79 lines (54 loc) · 4.19 KB
Raw

pubsEngine

github release hackage release stackage LTS package license

Manuscript Generator

pubsEngine is a Haskell application to convert Markdown markup formatted text file into several types of manuscripts. It can convert into:

  1. AASTeX formatted LaTeX document based on AASTEX63.cls from American Astronomical Society
  2. Basic Springer Nature LaTeX document template following this description
  3. Book format following kaobook template
  4. HTML Presentation following reveal.js
  5. Thesis format following Masters/Doctoral Thesis.

This application relies heavily on Pandoc library. You may consider this application as a merely extension/automation script for Pandoc.

This application extends the usage of several Markdown syntax, namely Image, CodeBlock classes, etc.

Installing

Just run make

If something goes wrong, never hesitate to raise the issue.

Notes on installation

to enable mermaid, in centos 7, do this:

  npm install @mermaid-js/mermaid-cli
  ln -sf  ~/node_modules/.bin/mmdc ~/.local/bin/mermaid

install PlantUML:

wget https://netcologne.dl.sourceforge.net/project/plantuml/plantuml.jar
mv plantuml.jar ${HOME}/opt
export PLANTUML_JAR=${HOME}/opt/plantuml.jar
java -jar ${PLANTUML_JAR}/plantuml.jar -eps:text sequenceDiagram.txt

Documentation

The detailed Usage Manual (stands also as a scaffold template) can be explored at template repository.

Contributing

Pull requests, bug reports, and feature requests are welcome. Please make sure to read the contributor guidelines before opening a new issue.

License

© 2018-2022 Hasan al Rasyid ([email protected]). Released under the GPL, version 2 or greater. This software carries no warranty of any kind. (See COPYRIGHT for full copyright and warranty notices.)

Warranty Notices (excerpted from License)

15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.