index.html

<!doctype html>
<html lang="en">
<head>

  <meta charset="utf-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1" />

  <meta name="author" content="Melchisedech333 - https://github.com/melchisedech333" />
  <meta name="description" content="Verbum Paper is a software that is intended to be used to facilitate the sharing of formulas, equations, and things involving mathematics." />

  <meta property="og:title" content="Verbum Paper">
  <meta property="og:type" content="website">
  <meta property="og:url" content="https://verbum-paper.github.io">
  <meta property="og:description" content="Verbum Paper - Share the math!">
  <meta property="og:image" content="https://verbum-paper.github.io/img/meta.png">

  <link rel="icon" href="./img/favicon.ico">
  <link rel="icon" href="./img/favicon.png" type="image/png">
  <link rel="apple-touch-icon" href="./img/favicon.png">

  <title>Verbum Paper</title>

  <link href="./libs/bootstrap-v5.2.0/css/bootstrap.min.css" rel="stylesheet" />
  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css" 
        integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" 
        crossorigin="anonymous" referrerpolicy="no-referrer" />
  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.5.1/styles/default.min.css">
  <link rel="stylesheet" href="./css/style.css" />

</head>
<body>
  
  <!-- Menu. -->
  <header class="d-flex flex-wrap align-items-center justify-content-center justify-content-md-between py-3 mb-4 border-bottom fixed-top nav-details">
    <div class="col-md-3 mb-2 mb-md-0"></div>

    <ul class="nav col-12 col-md-auto mb-2 justify-content-center mb-md-0">
      <li><a href="#home" class="nav-link px-2 link-dark"><i class="fa fa-home" ></i> Home</a></li>
      <li><a href="#project" class="nav-link px-2 link-dark"><i class="fa fa-star"></i> Project</a></li>
      <li><a href="#install" class="nav-link px-2 link-dark"><i class="fa fa-download" ></i> Install</a></li>
      <li><a href="#features" class="nav-link px-2 link-dark"><i class="fa fa-cubes" ></i> Features</a></li>
    </ul>

    <div class="col-md-3"></div>
  </header>

  <main>

    <!-- Top. -->
    <section class="py-5 text-center container" id="home" >
      <div class="row py-lg-5">
        <div class="col-lg-6 col-md-8 mx-auto">
          <br><br><br>
          <h1 class="fw-light">Verbum Paper</h1>
          <p class="lead text-muted">Share the math!</p>
          <p>
            <a href="https://github.com/verbum-paper/verbum-paper" class="btn btn-outline-secondary my-2">
              <i class="fa-brands fa-github"></i> Project on Github</a>
            <a href="https://github.com/sponsors/verbum-paper" class="btn btn-outline-secondary my-2">
              <i class="fa fa-heart"></i> Sponsor project</a>
          </p>
        </div>
      </div>
    </section>

    <!-- Sections. -->
    <div class="album bg-light">
      <div class="container">

        <!-- Section start. -->
        <section class="section-area" id="project" >
          <div class="row row-cols-1 row-cols-sm-2 row-cols-md-3 g-3">
            <div class="col-md-12" >

              <div class="section-title" >
                <h1 class="fw-light"><i class="fa fa-star"></i> The Project</h1>
              </div>
              
              <div class="section-text" >
                <p>

                  <center>
                    <img src="./img/1.png" width="70%">
                  </center>
                  <br><br>

                  Verbum Paper is a software that is intended to be used to facilitate the sharing of formulas, equations, and things involving mathematics.<br><br>

                  Through it you can write your file using CSS, HTML and Javascript code. You can import external libraries written in Javascript, such as for building graphics, or for something in particular.<br><br>

                  Via Verbum Paper you can insert graphics for functions (eg 2nd degree functions). You can also insert LaTex code mixed in with your HTML code. You can also copy your math expressions to Clipboard. This way you can easily share your math equations with your friends.

                </p>
              </div>

            </div>
          </div>
        </section>
        <!-- Section end. -->

        <div class="section-separator" ><hr></div>

        <!-- Section start. -->
        <section class="section-area" id="install" >
          <div class="row row-cols-1 row-cols-sm-2 row-cols-md-3 g-3">
            <div class="col-md-12" >

              <div class="section-title" >
                <h1 class="fw-light"><i class="fa fa-download" ></i> Install</h1>
              </div>
              
              <div class="section-text" >
                <p>

                  <b>Note: This installation process is for Linux environment.</b><br><br>

                  Requirements:
                  <ul>
                    <li>git</li>
                    <li>unzip</li>
                    <li>wget</li>
                  </ul>

                  <br>
                  Enter the directory where you want to install Verbum Paper, for example:

                  <pre><code class="language-bash">
mkdir ~/verbum-paper
cd ~/verbum-paper
</code></pre>

                  <br>
                  Run the install script:

                  <pre><code class="language-bash">
wget -c https://raw.githubusercontent.com/verbum-paper/verbum-paper/main/verbum-install/verbum-install.sh
chmod +x verbum-install.sh
./verbum-install.sh
</code></pre>

                  <br>
                  Creating shortcut in the operating system (Linux), example:


                  <pre><code class="language-bash">
sudo ln -s "$HOME/verbum-paper/shortcut.sh" /usr/bin/verbum-paper
</code></pre>

                  <br>
                  To open Verbum Paper, enter the command:


                  <pre><code class="language-bash">
verbum-paper
</code></pre>

                </p>
              </div>

            </div>
          </div>
        </section>
        <!-- Section end. -->

        <div class="section-separator" ><hr></div>

        <!-- Section start. -->
        <section class="section-area" id="features" >
          <div class="row row-cols-1 row-cols-sm-2 row-cols-md-3 g-3">
            <div class="col-md-12" >

              <div class="section-title" >
                <h1 class="fw-light"><i class="fa fa-cubes" ></i> Features</h1>
              </div>
              
              <div class="section-text" >
                <p>
                  
                  <h3>Copying to Clipboard</h3>

                  To copy your document, in image form, to the Clipboard, click on the icon:<br><Br>

                  <img src="./img/7.png" alt="">


                  <br><br><br><br>
                  <h3>LaTex code</h3>

                  To insert LaTex code, you must follow the MathLive specification: 

                  <a href="https://cortexjs.io/mathlive/reference/commands/" target="_blank" >https://cortexjs.io/mathlive/reference/commands/</a>

                  <br><br>
                  
                  Example to include an equation:

                  <br><br>

                  <pre><code class="language-latex">
\[x = {-b \pm \sqrt{b^2-4ac} \over 2a}.\]
                  </code></pre>

                  <br>

                  This code produces this view:

                  <br><br>

                  <img src="./img/3.png" alt="">

                  <br><br><Br><br>
                  <h3>Mathematical function graphs</h3>

                  To create graphs of quadratic functions, the Function Plot library is used. Exemple:

                  <br><br>


                  <pre><code class="language-html">
&lt;div id="function">&lt;/div>
                  </code></pre>

                  <pre><code class="language-javascript">
functionPlot({
    target: "#function",
    width: 400,
    height: 200,
    yAxis: { domain: [-1, 9] },
    grid: true,
    data: [ {
        fn: "x^2"
    }]
});
                  </code></pre>

                  <br>
                  The code above will produce this view:

                  <br><br>

                  <img src="./img/4.png" alt="">


                  <br><br><br><br>
                  <h3>Exporting files</h3>

                  To export your file to the formats: HTML, PNG and PDF; click on their respective icons.

                  <br><br>

                  <img src="./img/8.png" alt="">

                  <br><br><br><br>
                  <h3>More information</h3>

                  For more information, visit the project's Github page:

                  <a href="https://github.com/verbum-paper/verbum-paper" >https://github.com/verbum-paper/verbum-paper</a>

                </p>
              </div>

            </div>
          </div>
        </section>
        <!-- Section end. -->

        <div class="section-end" ></div>

      </div>
    </div>

  </main>

  <!-- Footer. -->
  <footer class="text-muted py-5">
    <div class="container">
      <p class="mb-1">
        Author: <a href="https://github.com/melchisedech333" >Melchisedech333</a><br>
        License: <a href="LICENSE.txt" >BSD-3-Clause license</a>
      </p>
      <p class="mb-0">
        <br>
        Made with love, in Brazil &#10084;
      </p>
    </div>
  </footer>

  <script src="./libs/bootstrap-v5.2.0/js/bootstrap.bundle.min.js"></script>
  <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.5.1/highlight.min.js"></script>
  <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.5.1/languages/javascript.min.js"></script>
  <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.5.1/languages/bash.min.js"></script>
  <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.5.1/languages/latex.min.js"></script>
  <script>hljs.highlightAll();</script>

</body>
</html>