Giter Club home page Giter Club logo

htmlyx's Introduction

HTMLyX

HTMLyX is still in early stages of development, and most features available in LyX are currently unsupported.

HTMLyX is a cross-platform LyX to HTML compiler.

Motivation

LyX is an open-source document processor. Usually, it export document as .tex file which are then compiled to .pdf using some installation of TeX. However, the multiple TeX instances of different operating systems make it difficult to compile files on different computers.

Moreover, the .pdf documents generated are not easily viewed on mobile devices with small screens. Attempts have been made to compile both LyX and LaTeX documents into html code, but such attempts are lacking in terms of Right-to-Left support and support of math equations. This project claim to provide adequate support for both.

Usage

usage: python main.py [-h] input_file output_file

Convert .lyx files to .html files.

positional arguments:
  input_file   path to a valid .lyx file
  output_file  where to store the resulting .html file

optional arguments:
  -h, --help   show this help message and exit

What's currently supported

  • Standard layout

  • Titles and numbered parts only (the numbers are not currently rendered)

  • Math insets (inline, display mode and math macros)

  • Supported styles: Series (bold) and bar (underline)

TODO:

  • Support all default layout types:

    • Standard

    • LyX-Code. note: the separator which LyX adds after the LyX-Code is not currently supported

    • Quotation

    • Quote

    • Verse

    • Verbatim/Verbatim*

    • Part/Part*

    • Section/Section*

    • Subsection/Subsection*

    • Subsubsection/Subsubsection*

    • Paragraph/Paragraph*

    • Subparagraph/Subparagraph*

    • Title

    • Author

    • Date

    • Abstract

    • Address

    • Right Address

    • Labeling

    • Itemize

    • Enumerate

    • Description

  • All text formatting:

    • Series

    • Shape

    • Size

    • Color

    • Underlining

    • Strikethrough

  • Boxes

  • Support ams-article layout types

  • Tables

  • Images - not fully supported yet but can be inserted and scaled uniformly using scale%.

  • Floating figures, algorithms and tables

  • Table of contents, table oparenthesis for RTLf algorithms

  • Bibliography

  • Labels & Cross references

  • Hyperlinks

  • Reverse parenthesis for RTL languages

Requirements

  1. Python 3.8+

  2. NodeJS with KaTeX installed.

License

HTMLyX is released under the GNU GPL version 3.0. The license can be found in LICENSE, but if for some reason it wasn't included with the code, you can find it here.

htmlyx's People

Contributors

ey321 avatar chipopo64bit avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.