Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Name fork fmark -> zesty markdown #11

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ All notable changes to the "fmark" extension will be documented in this file.
- Released first working version of the FMark plugin for vscode.
- It now supports
- Tables with spreadsheet functionality
- Macros
- Markdown syntax
- Macros Markdown syntax

## 0.1.1

Expand Down Expand Up @@ -74,3 +73,16 @@ can be done with it
## 0.4.0

- Replaced htmlpreview (deprecated) with Webview API.

## 0.5.0

- zesty-markdown fork because we lost access to the original publisher account
- Reordered README

## 0.5.1

- Added an icon

## 0.5.2

- Adjust README
65 changes: 34 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
# FMark [![Build Status](https://travis-ci.org/ymherklotz/FMark.svg?branch=master)](https://travis-ci.org/ymherklotz/FMark) by ZestyLogic 🍋♟
FSharp markdown implementation with additional functionality.
# Zesty Markdown 🍋

VSCode extension for Markdown Preview with additional functionality.

Namely:

- Macros
- Includes
- Includes (include other files e.g. to avoid copy-pasting repeated lines)
- Spreadsheet functionality
- Table of Contents generation
- Citations and footnotes
- Bibliography / citations and footnotes generation

See [example.fmark](https://github.com/zestylogic/FMark/blob/master/examples/example.fmark) for usage examples.

See [example.fmark](https://github.com/ymherklotz/FMark/blob/master/examples/example.fmark) for usage examples.
Uses [FMark](https://github.com/zestylogic/FMark) by Zesty Logic 🍋♟ under the hood.

# How to use

Expand All @@ -25,7 +28,7 @@ Open a live preview of the HTML that will be generated by FMark.

Create an HTML file in the same directory as the .fmark file, with .html instead of .fmark.

# Vanilla Markdown
# Vanilla Markdown

## Implemented
- HTML passthrough
Expand Down Expand Up @@ -82,23 +85,6 @@ A paragraph is some characters that does not match:

It terminates with two endlines. Any elements mentioned above cannot exist in a paragraph. Otherwise, they will become normal text, and will not be rendered as expected.

# Building

To build fmark, dotnet and fable have to be installed first. To build the javascript as well, yarn or npm are needed.

## Using the Build script

``` shell
# build only javascript
build -b js

# build and test every single module
build -b testall

# build js and cli
build -b all
```

# Markdown extensions

## Macros
Expand Down Expand Up @@ -157,7 +143,7 @@ For a list of strings, one can use the `preprocessList` and `lexList` functions.
[<EntryPoint>]
let main =
let inputStringList = (* Read the string list *)

inputStringList
|> preprocessList
|> lexList
Expand Down Expand Up @@ -195,12 +181,12 @@ Should be printed as not in scope: {{ local(arg1; arg2) }}
This is text inside the macro, with semicolons;
Now back in the first macro.

This is the second macro
This is the second macro


```

More complicated macros can also be created by writing html in the macros. Due to the
More complicated macros can also be created by writing html in the macros. Due to the
html passthrough in the lexer, the html will be copied over literally to the output html.

## Lexer
Expand All @@ -210,7 +196,7 @@ macros can give very useful and interesting functions.

## Interface to the Parser

The interface to the parser was done using the following `Token` type, which the parser takes in
The interface to the parser was done using the following `Token` type, which the parser takes in
and can parse.

``` f#
Expand All @@ -230,7 +216,7 @@ type Token =
Supports escaping of all the special characters defined in [Types](/FMark/FMark/src/Common/Types.fs). This is done by adding
a `\` in front of the character that should be escaped.

Tokens that match multiple characters can also be escaped by just putting a `\` before it. For example,
Tokens that match multiple characters can also be escaped by just putting a `\` before it. For example,
`***` can be escaped by writing `\***`.

## Extensibility
Expand All @@ -240,7 +226,7 @@ has to be linked to the token by adding it as a tuple of type `string * Token` t
`charList` in the [Lexer](/FMark/FMark/src/Common/Lexer/Lexer.fs).

## Spreadsheet functionality
Spreadsheet functions will evaluate in-place, if they are incorrectly formatted then Markalc will leave the cell unchanged as if it were normal text inside.
Spreadsheet functions will evaluate in-place, if they are incorrectly formatted then Markalc will leave the cell unchanged as if it were normal text inside.

To delineate an expression, start the cell with the `=` operator, e.g.

Expand Down Expand Up @@ -387,7 +373,7 @@ With Harvard, it will look like this:

At the end of the document:
> Smith, M. (2018) *Not a real book*.
>
>
> Smith, F. (2017) *Not a real website*. Available from: www.example.com/website [Accessed 4th March 2018].

if Chicago style is chosen:
Expand All @@ -396,7 +382,7 @@ if Chicago style is chosen:

At the end of the document:
> Mark Smith. 2018. *Not a real book*.
>
>
> FMark Smith. 2017. "Not a real website." Accessed March 3, 2018. https://www.example.com/website

## Latex maths rendering
Expand All @@ -406,3 +392,20 @@ Fmark includes support for Latex maths rendering.
Surround an equation written in Latex with `$$` in order to use this feature.

Example: `$$2+2=4-1=3$$`

# Development

To build fmark, dotnet and fable have to be installed first. To build the javascript as well, yarn or npm are needed.

## Using the Build script

``` shell
# build only javascript
build -b js

# build and test every single module
build -b testall

# build js and cli
build -b all
```
Binary file added images/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 11 additions & 9 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,27 +1,28 @@
{
"name": "fmark",
"displayName": "FMark",
"description": "FMark plugin",
"version": "0.4.0",
"publisher": "fmark",
"repository": "https://github.com/ymherklotz/FMark-vscode",
"name": "zesty-markdown",
"displayName": "Zesty Markdown 🍋",
"description": "Markdown preview with zest (see docs)",
"version": "0.5.2",
"publisher": "ps-george",
"repository": "https://github.com/zestylogic/FMark-vscode",
"engines": {
"vscode": "^1.89.0"
},
"categories": [
"Programming Languages"
],
"main": "./src/extension",
"icon": "./images/icon.png",
"license": "MIT",
"contributes": {
"commands": [
{
"command": "fmark.openPreview",
"title": "FMark: Open Preview"
"title": "Zesty Markdown 🍋: Open Preview"
},
{
"command": "fmark.makehtml",
"title": "FMark: Generate HTML File"
"title": "Zesty Markdown 🍋: Generate HTML File"
}
],
"keybindings": [
Expand All @@ -38,7 +39,8 @@
"fmark"
],
"extensions": [
".fmark"
".fmark",
".zesty"
],
"configuration": "./language-configuration.json"
}
Expand Down