-
-
+
+
|Primitive |Example|
|--- |---|
@@ -33,7 +36,7 @@ Note that this table is not compiled before production and currently needs to be
| If Statement |
*⚠️ This feature is not supported at the top-level scope, you can use it e.g. within functions. Works for Records and Maps as well.*| ```age := 18;```, ```p.age := 21``` | +|Assignment on an existing variable
*⚠️ This feature is not supported at the top-level scope, you can use it e.g. within functions. Works for Records and Maps as well.*| ```age := 18;```, ```p.age := 21``` | |Type Annotations| ```("tz1KqTpEZ7Yob7QbPE4Hy4Wo8fHG8LhKxZSx" : address)```| |Variants|
+
|Primitive |Example|
|--- |---|
@@ -75,7 +79,8 @@ Note that this table is not compiled before production and currently needs to be
|Transactions|
+
|Primitive |Example|
|--- |---|
@@ -107,7 +112,8 @@ Note that this table is not compiled before production and currently needs to be
|Transactions|
+
-
diff --git a/gitlab-pages/docs/intro/what-and-why.md b/gitlab-pages/docs/intro/what-and-why.md
index f195b97a7..4a68141da 100644
--- a/gitlab-pages/docs/intro/what-and-why.md
+++ b/gitlab-pages/docs/intro/what-and-why.md
@@ -3,6 +3,8 @@ id: what-and-why
title: Michelson and LIGO
---
+import Syntax from '@theme/Syntax';
+
Before we get into what LIGO is and why LIGO needs to exist, let us
take a look at what options the Tezos blockchain offers us out of the
box. If you want to implement smart contracts natively on Tezos, you
@@ -161,8 +163,9 @@ Let us decline the same LIGO contract in the three flavours above. Do
not worry if it is a little confusing at first; we will explain all
the syntax in the upcoming sections of the documentation.
-
-
+
+if age < 16
then failwith ("Too young to drive.");
else const new_id: int = prev_id + 1;type middleName is option(string);
const middleName : middleName = Some("Foo");
const middleName : middleName = None;*⚠️ This feature is not supported at the top-level scope, you can use it e.g. within functions. Works for Records and Maps as well.*| ```age := 18;```, ```p.age := 21``` | +|Assignment on an existing variable
*⚠️ This feature is not supported at the top-level scope, you can use it e.g. within functions. Works for Records and Maps as well.*| ```age := 18;```, ```p.age := 21``` | |Type Annotations| ```("tz1KqTpEZ7Yob7QbPE4Hy4Wo8fHG8LhKxZSx" : address)```| |Variants|
type action is
| Increment of int
| Decrement of intconst a: action = Increment(5);
case a of
| Increment(n) -> n + 1
| Decrement(n) -> n - 1
endconst payment : operation = transaction(unit, amount, receiver);let payment : operation =
Tezos.transaction unit amount receiverlet payment : operation =
Tezos.transaction (unit, amount, receiver);
-
+
@@ -23,6 +23,7 @@ people have spent at his shop when buying tacos.
## Analyzing the Current Contract
### **`taco-shop.ligo`**
+
```pascaligo group=a
type taco_supply is record [
current_stock : nat;
@@ -128,6 +129,7 @@ const operations : list (operation) = list [payoutOperation];
## Finalizing the Contract
### **`taco-shop.ligo`**
+
```pascaligo group=b
type taco_supply is record [
current_stock : nat;
@@ -190,7 +192,7 @@ ligo dry-run taco-shop.ligo --syntax pascaligo --amount 1 buy_taco 1n "map [
```
-
-
-
@@ -167,6 +168,7 @@ fields. Additionally, we will want to combine our `taco_supply` type into a map, consisting of the entire offer of Pedro's shop. **Taco shop's storage** + ```pascaligo group=b type taco_supply is record [ current_stock : nat; @@ -181,6 +183,7 @@ Next step is to update the `main` function to include `parameter` to `unit` as well to clear things up. **`taco-shop.ligo`** + ```pascaligo group=b+ type taco_supply is record [ current_stock : nat; @@ -204,6 +207,7 @@ initial storage value. In our case the storage is type-checked as our storage's value will be defined as follows: **Storage value** + ```zsh map [ 1n -> record [ @@ -221,6 +225,7 @@ map [ > by their keys `1n` and `2n`. **Dry run command with a multi-line storage value** + ```zsh ligo dry-run taco-shop.ligo --syntax pascaligo main unit "map [ 1n -> record [ @@ -235,7 +240,7 @@ ligo dry-run taco-shop.ligo --syntax pascaligo main unit "map [ ```
-
@@ -264,6 +269,7 @@ Let is start by customizing our contract a bit, we will: we will want to modify it **`taco-shop.ligo`** + ```pascaligo group=c type taco_supply is record [ current_stock : nat; @@ -320,7 +326,7 @@ function buy_taco (const taco_kind_index : nat; var taco_shop_storage : taco_sho ```
-
@@ -341,6 +347,7 @@ To make sure we get paid, we will: the payment accepted **`taco-shop.ligo`** + ```pascaligo group=e type taco_supply is record [ current_stock : nat; @@ -394,14 +401,14 @@ ligo dry-run taco-shop.ligo --syntax pascaligo --amount 1 buy_taco 1n "map [ ** Purchasing a Taco with 1tez **
-
**Attempting to Purchase a Taco with 0.7tez**
-
-
+
-
+
---
@@ -74,7 +74,7 @@ executable** through the installation script, as shown in the
screenshot below:
Operation(...bytes) included in the output
diff --git a/gitlab-pages/docs/tutorials/get-started/tezos-taco-shop-smart-contract.md b/gitlab-pages/docs/tutorials/get-started/tezos-taco-shop-smart-contract.md
index 48dfa29a5..986888889 100644
--- a/gitlab-pages/docs/tutorials/get-started/tezos-taco-shop-smart-contract.md
+++ b/gitlab-pages/docs/tutorials/get-started/tezos-taco-shop-smart-contract.md
@@ -16,7 +16,7 @@ consumers.
-
+
-Installing the next version of LIGO's CLI
+Installing the next version of LIGO's CLI
## Implementing our First `main` Function
@@ -90,6 +90,7 @@ contract, but it is something to get us started and test our LIGO
installation as well.
### `taco-shop.ligo`
+
```pascaligo group=a
function main (const parameter : int; const contractStorage : int) :
list (operation) * int is
@@ -150,7 +151,7 @@ ligo dry-run taco-shop.ligo --syntax pascaligo main 4 3
```
-Simulating contract execution with the CLI
+Simulating contract execution with the CLI
@@ -167,6 +168,7 @@ fields. Additionally, we will want to combine our `taco_supply` type into a map, consisting of the entire offer of Pedro's shop. **Taco shop's storage** + ```pascaligo group=b type taco_supply is record [ current_stock : nat; @@ -181,6 +183,7 @@ Next step is to update the `main` function to include `parameter` to `unit` as well to clear things up. **`taco-shop.ligo`** + ```pascaligo group=b+ type taco_supply is record [ current_stock : nat; @@ -204,6 +207,7 @@ initial storage value. In our case the storage is type-checked as our storage's value will be defined as follows: **Storage value** + ```zsh map [ 1n -> record [ @@ -221,6 +225,7 @@ map [ > by their keys `1n` and `2n`. **Dry run command with a multi-line storage value** + ```zsh ligo dry-run taco-shop.ligo --syntax pascaligo main unit "map [ 1n -> record [ @@ -235,7 +240,7 @@ ligo dry-run taco-shop.ligo --syntax pascaligo main unit "map [ ```
-Dry-run with a complex storage value
+Dry-run with a complex storage value
@@ -264,6 +269,7 @@ Let is start by customizing our contract a bit, we will: we will want to modify it **`taco-shop.ligo`** + ```pascaligo group=c type taco_supply is record [ current_stock : nat; @@ -320,7 +326,7 @@ function buy_taco (const taco_kind_index : nat; var taco_shop_storage : taco_sho ```
-Stock decreases after selling a taco
+Stock decreases after selling a taco
@@ -341,6 +347,7 @@ To make sure we get paid, we will: the payment accepted **`taco-shop.ligo`** + ```pascaligo group=e type taco_supply is record [ current_stock : nat; @@ -394,14 +401,14 @@ ligo dry-run taco-shop.ligo --syntax pascaligo --amount 1 buy_taco 1n "map [ ** Purchasing a Taco with 1tez **
-Stock decreases after selling a taco, if the right amount of tezzies is provided
+Stock decreases after selling a taco, if the right amount of tezzies is provided
**Attempting to Purchase a Taco with 0.7tez**
-Stock does not decrease after a purchase attempt
+
@@ -416,11 +423,13 @@ If you would like to accept tips in your contract, simply change the following line, depending on your preference. **Without tips** + ```pascaligo skip if amount =/= current_purchase_price then ``` **With tips** + ```pascaligo skip if amount >= current_purchase_price then ``` diff --git a/gitlab-pages/website/.gitignore b/gitlab-pages/website/.gitignore new file mode 100644 index 000000000..1b34df512 --- /dev/null +++ b/gitlab-pages/website/.gitignore @@ -0,0 +1,20 @@ +# dependencies +/node_modules + +# production +/build + +# generated files +.docusaurus +.cache-loader + +# misc +.DS_Store +.env.local +.env.development.local +.env.test.local +.env.production.local + +npm-debug.log* +yarn-debug.log* +yarn-error.log* \ No newline at end of file diff --git a/gitlab-pages/website/blog/2019-06-13-public-launch-of-ligo.md b/gitlab-pages/website/blog/2019-06-13-public-launch-of-ligo.md.old similarity index 100% rename from gitlab-pages/website/blog/2019-06-13-public-launch-of-ligo.md rename to gitlab-pages/website/blog/2019-06-13-public-launch-of-ligo.md.old diff --git a/gitlab-pages/website/blog/2019-07-11-ligo-update.md b/gitlab-pages/website/blog/2019-07-11-ligo-update.md.old similarity index 100% rename from gitlab-pages/website/blog/2019-07-11-ligo-update.md rename to gitlab-pages/website/blog/2019-07-11-ligo-update.md.old diff --git a/gitlab-pages/website/core/CodeExamples.js b/gitlab-pages/website/core/CodeExamples.js index 9cdf27c1c..289d14a73 100644 --- a/gitlab-pages/website/core/CodeExamples.js +++ b/gitlab-pages/website/core/CodeExamples.js @@ -1,8 +1,12 @@ -const React = require('react'); +import React from 'react'; +import Highlight, { defaultProps } from "prism-react-renderer"; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import useThemeContext from '@theme/hooks/useThemeContext'; +import defaultTheme from 'prism-react-renderer/themes/palenight'; +import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; -const pre = '```'; - -const PASCALIGO_EXAMPLE = `${pre}pascaligo +const PASCALIGO_EXAMPLE = ` type storage is int type parameter is @@ -14,8 +18,11 @@ type return is list (operation) * storage // Two entrypoints -function add (const store : storage; const delta : int) : storage is store + delta -function sub (const store : storage; const delta : int) : storage is store - delta +function add (const store : storage; const delta : int) : storage is + store + delta + +function sub (const store : storage; const delta : int) : storage is + store - delta (* Main access point that dispatches to the entrypoints according to the smart contract parameter. *) @@ -27,9 +34,9 @@ function main (const action : parameter; const store : storage) : return is | Decrement (n) -> sub (store, n) | Reset -> 0 end) -${pre}`; +`; -const CAMELIGO_EXAMPLE = `${pre}ocaml +const CAMELIGO_EXAMPLE = ` type storage = int type parameter = @@ -53,10 +60,10 @@ let main (action, store : parameter * storage) : return = Increment (n) -> add (store, n) | Decrement (n) -> sub (store, n) | Reset -> 0) -${pre}`; +`; -const REASONLIGO_EXAMPLE = `${pre}reasonligo +const REASONLIGO_EXAMPLE = ` type storage = int; type parameter = @@ -81,40 +88,82 @@ let main = ((action, store) : (parameter, storage)) : return => { | Decrement (n) => sub ((store, n)) | Reset => 0})) }; -${pre}`; +`; -module.exports = props => { - const MarkdownBlock = props.MarkdownBlock; +function CodeExamples (props) { + const { + siteConfig: { + themeConfig: {prism = {}}, + }, + } = useDocusaurusContext(); + const {isDarkTheme} = useThemeContext(); + const lightModeTheme = prism.theme || defaultTheme; + const darkModeTheme = prism.darkTheme || lightModeTheme; + const prismTheme = isDarkTheme ? darkModeTheme : lightModeTheme; return ( -
+
+
+ {({ className, style, tokens, getLineProps, getTokenProps }) => (
+
+
+
+
+
+ {({ className, style, tokens, getLineProps, getTokenProps }) => (
+
+
+
+
+
+ {({ className, style, tokens, getLineProps, getTokenProps }) => (
+
+
+
+
+
+
);
};
+
+export default CodeExamples
\ No newline at end of file
diff --git a/gitlab-pages/website/core/Footer.js b/gitlab-pages/website/core/Footer.js
index c40de4b0a..3aae1cda0 100644
--- a/gitlab-pages/website/core/Footer.js
+++ b/gitlab-pages/website/core/Footer.js
@@ -1,3 +1,5 @@
+// deprecated.
+
const React = require('react');
const docUrl = require(`${process.cwd()}/core/UrlUtils`).docUrl;
diff --git a/gitlab-pages/website/docusaurus.config.js b/gitlab-pages/website/docusaurus.config.js
new file mode 100644
index 000000000..d94dd362b
--- /dev/null
+++ b/gitlab-pages/website/docusaurus.config.js
@@ -0,0 +1,226 @@
+
+const repoUrl = 'https://gitlab.com/ligolang/ligo';
+
+// let reasonHighlightJs = require('reason-highlightjs');
+
+const siteConfig = {
+ title: 'LIGO', // Title for your website.
+ tagline: 'LIGO is a friendly smart contract language for Tezos',
+ // taglineSub: 'Michelson was never so easy',
+ url: 'https://ligolang.org', // Your website URL
+ baseUrl: '/', // Base URL for your project */
+ // For github.io type URLs, you would set the url and baseUrl like:
+ // url: 'https://facebook.github.io',
+ // baseUrl: '/test-site/',
+
+ // Used for publishing and more
+ projectName: 'ligo',
+ organizationName: 'TBN',
+ // For top-level user or org sites, the organization is still the same.
+ // e.g., for the https://JoelMarcey.github.io site, it would be set like...
+ // organizationName: 'JoelMarcey'
+
+ // For no header links in the top nav bar -> headerLinks: [],
+
+
+ // footerLinks: {
+ // docs: [
+ // { doc: 'intro/installation', label: 'Install' },
+ // { doc: 'api/cli-commands', label: 'CLI Commands' },
+ // { doc: 'contributors/origin', label: 'Contribute' },
+ // { href: '/odoc', label: 'API Documentation' }
+ // ],
+ // community: [
+ // {
+ // href: 'https://forum.tezosagora.org/tag/ligo',
+ // label: 'Tezos Agora Forum',
+ // blankTarget: true
+ // },
+ // {
+ // href: 'https://tezos.stackexchange.com/questions/tagged/ligo',
+ // label: 'Tezos Stack Exchange',
+ // blankTarget: true
+ // },
+ // {
+ // href: 'https://t.me/LigoLang',
+ // label: 'Telegram',
+ // blankTarget: true
+ // },
+ // {
+ // href: 'https://discord.gg/9rhYaEt',
+ // label: 'Discord',
+ // blankTarget: true
+ // }
+ // ],
+ // more: [
+ // {
+ // doc: 'tutorials/get-started/tezos-taco-shop-smart-contract',
+ // label: 'Tutorials'
+ // },
+ // { href: repoUrl, label: 'GitLab' }
+ // ]
+ // },
+
+ favicon: 'img/circle.svg',
+
+ /* highlight: {
+ // Highlight.js theme to use for syntax highlighting in code blocks.
+ theme: 'default',
+ hljs: function (hljs) {
+ hljs.registerLanguage('reasonligo', reasonHighlightJs);
+ hljs.registerLanguage('pascaligo', function (hljs) {
+ return {
+ // case_insensitive: true,
+ beginKeywords: '',
+ keywords: {
+ keyword:
+ 'and attributes begin big_map block case const contains else'
+ + ' end False for from function if in is list map mod nil'
+ + ' not of or patch record remove set skip then to True type'
+ + ' var while with',
+ literal: 'true false unit int string Some None bool nat list'
+ },
+ lexemes: '[a-zA-Z][a-zA-Z0-9_]*',
+ contains: [
+ hljs.C_LINE_COMMENT_MODE,
+
+ {
+ className: 'type',
+ begin: /[A-Z][a-z]+/
+ },
+ {
+ begin: /[*+-:;\(\)\{\}|\>\<]/
+ // className: 'ignore'
+ }
+ ]
+ };
+ });
+ }
+ },*/
+
+ // Add custom scripts here that would be placed in
Stock does not decrease after a purchase attempt
with an insufficient payment.
@@ -416,11 +423,13 @@ If you would like to accept tips in your contract, simply change the following line, depending on your preference. **Without tips** + ```pascaligo skip if amount =/= current_purchase_price then ``` **With tips** + ```pascaligo skip if amount >= current_purchase_price then ``` diff --git a/gitlab-pages/website/.gitignore b/gitlab-pages/website/.gitignore new file mode 100644 index 000000000..1b34df512 --- /dev/null +++ b/gitlab-pages/website/.gitignore @@ -0,0 +1,20 @@ +# dependencies +/node_modules + +# production +/build + +# generated files +.docusaurus +.cache-loader + +# misc +.DS_Store +.env.local +.env.development.local +.env.test.local +.env.production.local + +npm-debug.log* +yarn-debug.log* +yarn-error.log* \ No newline at end of file diff --git a/gitlab-pages/website/blog/2019-06-13-public-launch-of-ligo.md b/gitlab-pages/website/blog/2019-06-13-public-launch-of-ligo.md.old similarity index 100% rename from gitlab-pages/website/blog/2019-06-13-public-launch-of-ligo.md rename to gitlab-pages/website/blog/2019-06-13-public-launch-of-ligo.md.old diff --git a/gitlab-pages/website/blog/2019-07-11-ligo-update.md b/gitlab-pages/website/blog/2019-07-11-ligo-update.md.old similarity index 100% rename from gitlab-pages/website/blog/2019-07-11-ligo-update.md rename to gitlab-pages/website/blog/2019-07-11-ligo-update.md.old diff --git a/gitlab-pages/website/core/CodeExamples.js b/gitlab-pages/website/core/CodeExamples.js index 9cdf27c1c..289d14a73 100644 --- a/gitlab-pages/website/core/CodeExamples.js +++ b/gitlab-pages/website/core/CodeExamples.js @@ -1,8 +1,12 @@ -const React = require('react'); +import React from 'react'; +import Highlight, { defaultProps } from "prism-react-renderer"; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import useThemeContext from '@theme/hooks/useThemeContext'; +import defaultTheme from 'prism-react-renderer/themes/palenight'; +import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; -const pre = '```'; - -const PASCALIGO_EXAMPLE = `${pre}pascaligo +const PASCALIGO_EXAMPLE = ` type storage is int type parameter is @@ -14,8 +18,11 @@ type return is list (operation) * storage // Two entrypoints -function add (const store : storage; const delta : int) : storage is store + delta -function sub (const store : storage; const delta : int) : storage is store - delta +function add (const store : storage; const delta : int) : storage is + store + delta + +function sub (const store : storage; const delta : int) : storage is + store - delta (* Main access point that dispatches to the entrypoints according to the smart contract parameter. *) @@ -27,9 +34,9 @@ function main (const action : parameter; const store : storage) : return is | Decrement (n) -> sub (store, n) | Reset -> 0 end) -${pre}`; +`; -const CAMELIGO_EXAMPLE = `${pre}ocaml +const CAMELIGO_EXAMPLE = ` type storage = int type parameter = @@ -53,10 +60,10 @@ let main (action, store : parameter * storage) : return = Increment (n) -> add (store, n) | Decrement (n) -> sub (store, n) | Reset -> 0) -${pre}`; +`; -const REASONLIGO_EXAMPLE = `${pre}reasonligo +const REASONLIGO_EXAMPLE = ` type storage = int; type parameter = @@ -81,40 +88,82 @@ let main = ((action, store) : (parameter, storage)) : return => { | Decrement (n) => sub ((store, n)) | Reset => 0})) }; -${pre}`; +`; -module.exports = props => { - const MarkdownBlock = props.MarkdownBlock; +function CodeExamples (props) { + const { + siteConfig: { + themeConfig: {prism = {}}, + }, + } = useDocusaurusContext(); + const {isDarkTheme} = useThemeContext(); + const lightModeTheme = prism.theme || defaultTheme; + const darkModeTheme = prism.darkTheme || lightModeTheme; + const prismTheme = isDarkTheme ? darkModeTheme : lightModeTheme; return ( -
-
+
+
-
-
- PascaLIGO
-
-
- CameLIGO
-
-
- ReasonLIGO
-
-
-
-
- {PASCALIGO_EXAMPLE}
-
-
- {CAMELIGO_EXAMPLE}
-
-
- {REASONLIGO_EXAMPLE}
-
-
+ {tokens.map((line, i) => (
+
+ {line.map((token, key) => (
+
+ ))}
+
+ ))}
+
+ )}
+
+ {tokens.map((line, i) => (
+
+ {line.map((token, key) => (
+
+ ))}
+
+ ))}
+
+ )}
+
+ {tokens.map((line, i) => (
+
+ {line.map((token, key) => (
+
+ ))}
+
+ ))}
+
+ )}
+