Foremark

Write a beautiful, sharable
document using a text editor.

Get Started
GitHub

Foremark is currently under development — You might find some features incomplete or broken.

Foremark is a technology for writing a plain-text document which renders nicely on a web browser.

It does not require a plugin, pre-compilation process, or dedicated viewer software.

Example.fm.xhtml

            **Hello**

Welcome to _Foremark_!

:::           .----------.
::: Write --> | Document | --> Web Browser
:::           '----------'

Example

Hello

Welcome to Foremark!

Why Use Foremark?

Being a plain text file, it can be easily edited by any text editor of your choice. It also works very well with most version control systems.
Foremark automatically loads assets from CDN, but if needed, it can fully operate without an internet connection. Use a self-contained bundle (foremark.bundle.js) available here.
Created documents can be shared easily as they are self-contained, only need a web browser to display, and adapt to various display devices (e.g., PC, tablet, and paper).
The syntax is based on Markdown with some extensions and easy to learn and use.

Get Started

Copy the following code, save it as hello.fm.xhtml, and open it with a web browser.

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"><pre><![CDATA[

                            **Title**

Welcome to Foremark!

:::           .----------.
::: Write --> | Document | --> Web Browser
:::           '----------'

# Section

## Subsection

Content

]]></pre> <!-- Foremark footer -->
<script src="https://unpkg.com/foremark/browser/foremark.js" async="async"/></html>

Next step: ~~Book~~ Reference Manual

Foremark Is Powered By...

The formatting of Foremark pulls much inspiration from John Gruber’s Markdown while making many intentional changes.
Foremark was heavily inspired by Morgan McGuire’s Markdeep. It also includes a portion of Markdeep.
Rendering of an ASCII diagram is performed using a Rust library Svgbob.
Displaying LaTeX equations was made possible by a JavaScript library KaTeX.
Foremark is built using Webpack. Its code splitting feature is essential for lazy-loading various components.
The code highlighting feature is provided by a JavaScript library Highlight.js.