Start adding docs

hrushikeshrv · Jun 4, 2021 · 9a23f86 · 9a23f86
1 parent de0a6a0
commit 9a23f86
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -7,6 +7,9 @@ primarily for use with MathJax.
 
 docxlatex DOES NOT convert the entire .docx file to a LaTeX source file.
 
+docxlatex is still in beta and does not work perfectly on all equations. However, 
+it does work with reasonable accuracy on standard symbols and equations.
+
 # Installation
 Install using pip  
 `pip install docxlatex`
@@ -39,9 +42,10 @@ doc.block_delimiter = "%%" # "$$" by default
 docxlatex currently requires all the mathematical equations in the .docx document to be converted into linear format to extract successfully. I am adding support for 
 equations in the professional format right now. Future releases will let you use it without having to use this workaround, but for now, make sure all the equations in the .docx file are converted into linear form.  
 
-To convert all your equations into linear format, click on any equation, go to the Equation tab, make sure LaTeX is selected, and click on Convert > All - Linear
+To convert all your equations into linear format, click on any equation, go to the Equation tab, make sure LaTeX is selected, and click on Convert &#8594; All - Linear
+
+Please report any bugs on this project's GitHub page [hrushikeshrv/docxlatex](https://github.com/hrushikeshrv/docxlatex/issues)
 
 # TODOs
 - [ ] Extract all images present in the file and return them as file-like objects
 - [ ] Add support for equations in professional formatting
-- [ ] Clean up equations in linear format that do not directly convert to valid LaTeX
diff --git a/docs/index.html b/docs/index.html
@@ -1,8 +1,11 @@
 <!DOCTYPE html>
 <html lang="en">
 <head>
+    <meta name="viewport" content="width=device-width, initial-scale='1'">
     <meta charset="UTF-8">
-    <title>Title</title>
+    <meta name="author" content="Hrushikesh Vaidya | @hrushikeshrv on GitHub">
+    <meta name="description" content="docxlatex is a python package to extract text and mathematical equations from .docx files. It returns the equations wrapped in delimiters and converted to valid LaTeX syntax">
+    <title>DocxLatex - Extract text and equations from .docx files</title>
 </head>
 <body>
 

diff --git a/docs/styles.css b/docs/styles.css
@@ -0,0 +1,18 @@
+*, *::before, *::after {
+    box-sizing: border-box;
+}
+
+root {
+    --background-light-1: rgb(255, 255, 255);
+    --background: rgb(245, 245, 245);
+    --background-dark-1: rgb(226, 226, 226);
+    --background-dark-2: rgb(202, 200, 200);
+    --background-dark-3: rgb(184, 184, 184);
+
+    --primary-color: rgb(140, 243, 113);
+}
+
+body, html {
+    margin: 0;
+    padding: 0;
+}
diff --git a/docxlatex.egg-info/PKG-INFO b/docxlatex.egg-info/PKG-INFO
@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: docxlatex
-Version: 0.1.4
+Version: 0.1.5
 Summary: Extract text from .docx files with support for inserted equations
 Home-page: https://github.com/hrushikeshrv/docxlatex
 Author: Hrushikesh Vaidya
@@ -45,7 +45,9 @@ Description: # docxlatex
 
         # Limitation
         docxlatex currently requires all the mathematical equations in the .docx document to be converted into linear format to extract successfully. I am adding support for 
-        equations in the professional format right now. Soon you will be able to use it without having to use this workaround, but for now, open the .docx file in Word, click on any equation, click on the right context menu > All - linear.
+        equations in the professional format right now. Future releases will let you use it without having to use this workaround, but for now, make sure all the equations in the .docx file are converted into linear form.  
+
+        To convert all your equations into linear format, click on any equation, go to the Equation tab, make sure LaTeX is selected, and click on Convert > All - Linear
 
         # TODOs
         - [ ] Extract all images present in the file and return them as file-like objects