Web

Mathematical Text to Web Article

Web articles are modern, portable, easy to write, and deploy with minimal overhead or setup.

Texsydo Web Operations

Operations provide commands to create, build, and deploy mathematical articles in your domain-specific system.

⚠️ Texsydo Web is a challenging project, so its current MVP versions do not guarantee API stability for now. Texsydo Web tsd-web CLI is currently in the prototype stage without public availability until its ongoing migration to MVP finishes.

Creating Domain Aware Articles

.
├── mathswe
    ├── eng
        ├── automation
            └── platform
                └── ops
                    └── automating-the-platform-operations-and-beyond-2023-08-31
                        └── index.md

Repository Articles

Markdown to Static Site

⚠️ Texsydo Web MVP will drop support for Jekyll later when it reaches a more mature stage.

Development Server

GitHub Pages Deployment

It deploys the given article from the main branch to the gh-pages one.

Smart Text Transformations

Declarative user dictionaries tell Texsydo the transformations from the low-level form of a word used as a syntax to the high-level word to render.

Dictionaries keep the system domain-specific and, therefore, well-informed and efficient by removing redundant work prone to errors and writer burnout.

Dictionary(
    uppercase = setOf("bsd", "pr"),
    composed = mapOf(
        "mathswe" to listOf("math", "swe"),
        "github"  to listOf("git", "hub"),
    ),
    acronym = mapOf(
        "swam" to "Special Software and Models",
        "ddo"  to "Data-Driven Organizations",
    ),
    custom = mapOf(
        "intellij-idea" to "IntelliJ IDEA",
        "leds"          to "LEDs",
    )
)

Map of Words

• bsd

  ${\displaystyle \to }$

  BSD

  pr

  ${\displaystyle \to }$

  PR
• mathswe

  ${\displaystyle \to }$

  MathSwe

  github

  ${\displaystyle \to }$

  GitHub
• swam

  ${\displaystyle \to }$

  Special Software and Models

  ddo

  ${\displaystyle \to }$

  Data-Driven Organizations
• intellij-idea

  ${\displaystyle \to }$

  IntelliJ IDEA

  leds

  ${\displaystyle \to }$

  LEDs

Example Project Associated with an Article

Technical articles can contain an associated project offering complete source code to readers, while standard articles can still provide files. Everything is first-class, with cohesive navigation without leaving the website.

In-article projects are Example Projects (EPs) since the article bounds them to that scope. The unique EP benefits can thus enhance the value a technical article provides.

If the article contains a web app project, Texsydo Web will also build and deploy it within the article.

 📂 drawing-a-tree-on-canvas-with-xy-coordinates
    ├── index.md
    ├── 📂 mrm-solution-tree---ep
    │      ├── other-project-files...
    │      ├── package.json
    │      ├── package-lock.json
    │      ├── README.md
    │      ├── 📂 src
    │      │      ├── index.html
    │      │      └── other-project-sources...
    │      ├── tsconfig.json
    │      └── webpack.config.js
    └── other-article-files...

Drawing a Tree on Canvas with XY Coordinates

Advanced additions like associated files, example project source code, and web apps enhance articles by growing them cohesively. Texsydo Web allows articles to specify their DSL enabling completeness from the academic text to the engineering specification.

Clear and Complete Development Communication

Texsydo Web infers development workflow to automate updates of PR and Release blogs, currently only available for MathSwe projects.

It uses the syntax of the create command plus path and from-pr arguments.

• path is the GitHub repository path, likeorg/repo.
• from-pr is the first PR number to take (inclusive), and the program will fetch the rest of the PRs until the last one. This option doesn’t provide more flexibility yet.

tsd-web add-pr \
initializing-ops-with-a-cookie-banner---mathswe-com-2024-03-21 \
mathswe, legal, cookies, pr \
mathswe/legal \
1

The pr class must be the direct parent directory of the article to enable inference, as shown above.

It creates the article in the mathswe/legal/cookies/pr directory. It adds the PRs from GitHub with proper styles. It requires developers to maintain balanced communication on GitHub to move forward continuously in a linear direction.

The remaining developer's job is to finish the article with the conclusion and abstract sections and add the cover textual file. Texsydo will build it into a PNG image according to MathSwe graphical standards.

A Markdown source file defines the cover image with the same name as the article and .png.md extension. It must contain a tiny abstract with an optional list. It supports bold style.

While support for PR articles is wider, current support for Release articles is limited to generating the cover image.

Texsydo Web enables efficient and thoroughly formal written communication from low-level technical details to high-level product engineering as per MathSwe standards.