diff --git a/gitlab-pages/.dockerignore b/gitlab-pages/.dockerignore new file mode 100644 index 000000000..27d2dae2b --- /dev/null +++ b/gitlab-pages/.dockerignore @@ -0,0 +1,2 @@ +*/node_modules +*.log diff --git a/gitlab-pages/.gitignore b/gitlab-pages/.gitignore new file mode 100644 index 000000000..5395ea795 --- /dev/null +++ b/gitlab-pages/.gitignore @@ -0,0 +1,12 @@ +.DS_Store + +node_modules + +lib/core/metadata.js +lib/core/MetadataBlog.js + +website/translated_docs +website/build/ +website/yarn.lock +website/node_modules +website/i18n/* diff --git a/gitlab-pages/.gitlab-ci.yml b/gitlab-pages/.gitlab-ci.yml new file mode 100644 index 000000000..1d6954b9c --- /dev/null +++ b/gitlab-pages/.gitlab-ci.yml @@ -0,0 +1,16 @@ +image: node:8 + +before_script: + - cd website + - npm install + +pages: + script: + - npm run build + - cd .. + - cp -r website/build/ligo public + artifacts: + paths: + - public + only: + - master diff --git a/gitlab-pages/Dockerfile b/gitlab-pages/Dockerfile new file mode 100644 index 000000000..d369844d5 --- /dev/null +++ b/gitlab-pages/Dockerfile @@ -0,0 +1,10 @@ +FROM node:8.11.4 + +WORKDIR /app/website + +EXPOSE 3000 35729 +COPY ./docs /app/docs +COPY ./website /app/website +RUN yarn install + +CMD ["yarn", "start"] diff --git a/gitlab-pages/LICENSE b/gitlab-pages/LICENSE new file mode 100644 index 000000000..f22cd192a --- /dev/null +++ b/gitlab-pages/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2019 Matej Šima + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/gitlab-pages/Makefile b/gitlab-pages/Makefile new file mode 100644 index 000000000..fab8d821f --- /dev/null +++ b/gitlab-pages/Makefile @@ -0,0 +1,2 @@ +up: + docker-compose up diff --git a/gitlab-pages/README.md b/gitlab-pages/README.md new file mode 100644 index 000000000..718146e8b --- /dev/null +++ b/gitlab-pages/README.md @@ -0,0 +1,9 @@ +# Ligo documentation + +## Running the documentation website + +The website will be available at [http://localhost:3000](http://localhost:3000) + +```zsh +docker-compose up +``` \ No newline at end of file diff --git a/gitlab-pages/counter.pp.ligo b/gitlab-pages/counter.pp.ligo new file mode 100644 index 000000000..16ac3bc7b --- /dev/null +++ b/gitlab-pages/counter.pp.ligo @@ -0,0 +1,67 @@ +# 1 "examples/counter.ligo" +# 1 "" +# 1 "" +# 31 "" +# 1 "/usr/include/stdc-predef.h" 1 3 4 + +# 17 "/usr/include/stdc-predef.h" 3 4 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +# 32 "" 2 +# 1 "examples/counter.ligo" +type action is +| Increment of int +| Decrement of int + +const coeficient : int = 2; + +function main (const p : action ; const s : int) : (list(operation) * int) is + block {skip} with ((nil : list(operation)), + case p of + | Increment n -> s + n + | Decrement n -> s - n + end) diff --git a/gitlab-pages/docker-compose.yml b/gitlab-pages/docker-compose.yml new file mode 100644 index 000000000..6711192ae --- /dev/null +++ b/gitlab-pages/docker-compose.yml @@ -0,0 +1,18 @@ +version: "3" + +services: + docusaurus: + build: . + ports: + - 3000:3000 + - 35729:35729 + volumes: + - ./docs:/app/docs + - ./website/blog:/app/website/blog + - ./website/core:/app/website/core + - ./website/i18n:/app/website/i18n + - ./website/pages:/app/website/pages + - ./website/static:/app/website/static + - ./website/sidebars.json:/app/website/sidebars.json + - ./website/siteConfig.js:/app/website/siteConfig.js + working_dir: /app/website diff --git a/gitlab-pages/docs/api-cli-commands.md b/gitlab-pages/docs/api-cli-commands.md new file mode 100644 index 000000000..aa75e3a0b --- /dev/null +++ b/gitlab-pages/docs/api-cli-commands.md @@ -0,0 +1,47 @@ +--- +id: api-cli-commands +title: CLI Commands +--- + +Contracts written in Ligo can be compiled using the `ligo` executable. + + +## Compiling a contract + +Compile your contract with a specific entry point. + +```zsh +ligo compile-contract SOURCE_FILE [ENTRY_POINT] +``` + +#### Example + +```zsh +ligo compile-contract examples/counter.ligo main +``` + +## Defining the initial storage + +If your contract implements a sophisticated storage, you can compile a Ligo expression into a Michelson value quite easily. + +```zsh +ligo compile-storage SOURCE_FILE ENTRY_POINT EXPRESSION +``` + +#### Example +```zsh +ligo compile-storage examples/counter.ligo main 5 +# Outputs: 5 +``` + +## Invoking the contract with a parameter + +```zsh +ligo compile-parameter SOURCE_FILE ENTRY_POINT EXPRESSION +``` + +#### Example +```zsh +ligo compile-parameter examples/counter.ligo main "Increment(5)" +# Outputs: (Right 5) +``` \ No newline at end of file diff --git a/gitlab-pages/docs/language-basics-entrypoints.md b/gitlab-pages/docs/language-basics-entrypoints.md new file mode 100644 index 000000000..ecb6ae65e --- /dev/null +++ b/gitlab-pages/docs/language-basics-entrypoints.md @@ -0,0 +1,44 @@ +--- +id: language-basics-entrypoints +title: Entrypoints +--- + +## Defining an entry point + + + +```Pascal +function main (const p : int ; const s : int) : (list(operation) * unit) is + block {skip} with ((nil : list(operation)), s + 1) +``` + + +## Multiple entry points + +Multiple entrypoints are currently not supported in Michelson, however with Ligo, you can work that around by using variants. + + + +```Pascal +// variant defining pseudo multi-entrypoint actions +type action is +| Increment of int +| Decrement of int + +function add (const a : int ; const b : int) : int is + block { skip } with a + b + +function subtract (const a : int ; const b : int) : int is + block { skip } with a - b + +// real entrypoint that re-routes the flow based on the action provided +function main (const p : action ; const s : int) : (list(operation) * int) is + block {skip} with ((nil : list(operation)), + case p of + | Increment n -> add(s, n) + | Decrement n -> subtract(s, n) + end) +``` + + + \ No newline at end of file diff --git a/gitlab-pages/docs/language-basics-functions.md b/gitlab-pages/docs/language-basics-functions.md new file mode 100644 index 000000000..b082b69b1 --- /dev/null +++ b/gitlab-pages/docs/language-basics-functions.md @@ -0,0 +1,22 @@ +--- +id: language-basics-functions +title: Functions +--- + +## Defining a function + + + +```Pascal +// multiply(1, 2) = 2 +function multiply (const a : int ; const b : int) : int is + begin + const result : int = a * b ; + end with result + +// add(1, 2) = 3 +function add (const a : int ; const b : int) : int is + block { skip } with a + b +``` + + \ No newline at end of file diff --git a/gitlab-pages/docs/language-basics-operators.md b/gitlab-pages/docs/language-basics-operators.md new file mode 100644 index 000000000..faf0fdde2 --- /dev/null +++ b/gitlab-pages/docs/language-basics-operators.md @@ -0,0 +1,12 @@ +--- +id: language-basics-operators +title: Operators +--- + +## Available operators + +|Michelson |Pascaligo |Description | +|--- |--- |--- | +| `SENDER` | `sender` | Address that initiated the current transaction +| `SOURCE` | `source` | Address that initiated the transaction, which triggered the current transaction. (useful e.g. when there's a transaction sent by another contract) +| `AMOUNT` | `amount` | Amount of tez sent by the transaction that invoked the contract \ No newline at end of file diff --git a/gitlab-pages/docs/language-basics-variables.md b/gitlab-pages/docs/language-basics-variables.md new file mode 100644 index 000000000..4f222e5b1 --- /dev/null +++ b/gitlab-pages/docs/language-basics-variables.md @@ -0,0 +1,18 @@ +--- +id: language-basics-variables +title: Variables +--- + +## Defining a variable + + + +```Pascal +// int +const four : int = 4; + +// string +const name : string = "John Doe"; +``` + + \ No newline at end of file diff --git a/gitlab-pages/docs/setup-installation.md b/gitlab-pages/docs/setup-installation.md new file mode 100644 index 000000000..a08db5e30 --- /dev/null +++ b/gitlab-pages/docs/setup-installation.md @@ -0,0 +1,36 @@ +--- +id: setup-installation +title: Installation +--- + +There are currently two ways to get started with Ligo, both of those will allow you to use the Ligo CLI with your contracts. You can choose to use either the Docker image, or to compile & build the Ligo CLI yourself. + +## Docker + +> 🐳 You can find instructions on how to install Docker [here](https://docs.docker.com/install/). + +Easiest way to use LIGO is through the Docker image available at [Docker Hub](https://hub.docker.com/r/stovelabs/granary-ligo). Sources for the image can be found on [Github](https://github.com/stove-labs/granary/blob/develop/docker/ligo/Dockerfile). +You can either run the docker image yourself, or you can setup a global ligo executable as shown below. + +### Setting up a globally available `ligo` executable +```zsh +wget https://gitlab.com/maht0rz/ligo-documentation/blob/master/ligo-docker.sh && \ +sudo cp ligo-docker.sh /usr/local/bin/ligo && \ +sudo chmod +x /usr/local/bin/ligo && \ +rm ligo-docker.sh +``` + +> ⚠️ Please note that the **current docker image is quite chunky**, it may take a while to download depending on your internet connection. + +**Verify your ligo installation by running:** +```zsh +ligo --help +``` + + +## Manual installation + +For now, please refer to the steps described in the [Dockerfile](https://github.com/stove-labs/granary/blob/develop/docker/ligo/Dockerfile). + + + diff --git a/gitlab-pages/examples/counter.ligo b/gitlab-pages/examples/counter.ligo new file mode 100644 index 000000000..45ce7462a --- /dev/null +++ b/gitlab-pages/examples/counter.ligo @@ -0,0 +1,10 @@ +type action is +| Increment of int +| Decrement of int + +function main (const p : action ; const s : int) : (list(operation) * int) is + block {skip} with ((nil : list(operation)), + case p of + | Increment n -> s + n + | Decrement n -> s - n + end) diff --git a/gitlab-pages/examples/functions.ligo b/gitlab-pages/examples/functions.ligo new file mode 100644 index 000000000..4f8e4dae1 --- /dev/null +++ b/gitlab-pages/examples/functions.ligo @@ -0,0 +1,10 @@ +function multiply (const a : int ; const b : int) : int is + begin + const result : int = a * b ; + end with result + +function add (const a : int ; const b : int) : int is + block { skip } with a + b + +function main (const p : unit ; const s : unit) : (list(operation) * unit) is + block {skip} with ((nil : list(operation)), s) \ No newline at end of file diff --git a/gitlab-pages/examples/multiple-entrypoints.ligo b/gitlab-pages/examples/multiple-entrypoints.ligo new file mode 100644 index 000000000..3b77ff009 --- /dev/null +++ b/gitlab-pages/examples/multiple-entrypoints.ligo @@ -0,0 +1,16 @@ +type action is +| Increment of int +| Decrement of int + +function add (const a : int ; const b : int) : int is + block { skip } with a + b + +function subtract (const a : int ; const b : int) : int is + block { skip } with a - b + +function main (const p : action ; const s : int) : (list(operation) * int) is + block {skip} with ((nil : list(operation)), + case p of + | Increment n -> add(s, n) + | Decrement n -> subtract(s, n) + end) diff --git a/gitlab-pages/examples/variables.ligo b/gitlab-pages/examples/variables.ligo new file mode 100644 index 000000000..09254da96 --- /dev/null +++ b/gitlab-pages/examples/variables.ligo @@ -0,0 +1,5 @@ +const four : int = 4; +const name : string = "John Doe"; + +function main (const p : unit ; const s : unit) : (list(operation) * unit) is + block {skip} with ((nil : list(operation)), s) \ No newline at end of file diff --git a/gitlab-pages/functions.pp.ligo b/gitlab-pages/functions.pp.ligo new file mode 100644 index 000000000..275322392 --- /dev/null +++ b/gitlab-pages/functions.pp.ligo @@ -0,0 +1,65 @@ +# 1 "examples/functions.ligo" +# 1 "" +# 1 "" +# 31 "" +# 1 "/usr/include/stdc-predef.h" 1 3 4 + +# 17 "/usr/include/stdc-predef.h" 3 4 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +# 32 "" 2 +# 1 "examples/functions.ligo" +function multiply (const a : int ; const b : int) : int is + begin + const result : int = a * b ; + end with result + +function add (const a : int ; const b : int) : int is + block { skip } with a + b + +function main (const p : unit ; const s : unit) : (list(operation) * unit) is + block {skip} with ((nil : list(operation)), s) diff --git a/gitlab-pages/ligo-docker.sh b/gitlab-pages/ligo-docker.sh new file mode 100755 index 000000000..310ab18fa --- /dev/null +++ b/gitlab-pages/ligo-docker.sh @@ -0,0 +1,2 @@ +#!/bin/bash +docker run -v $PWD:$PWD -w $PWD stovelabs/granary-ligo $@ \ No newline at end of file diff --git a/gitlab-pages/multiple-entrypoints.pp.ligo b/gitlab-pages/multiple-entrypoints.pp.ligo new file mode 100644 index 000000000..77e8137f0 --- /dev/null +++ b/gitlab-pages/multiple-entrypoints.pp.ligo @@ -0,0 +1,71 @@ +# 1 "examples/multiple-entrypoints.ligo" +# 1 "" +# 1 "" +# 31 "" +# 1 "/usr/include/stdc-predef.h" 1 3 4 + +# 17 "/usr/include/stdc-predef.h" 3 4 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +# 32 "" 2 +# 1 "examples/multiple-entrypoints.ligo" +type action is +| Increment of int +| Decrement of int + +function add (const a : int ; const b : int) : int is + block { skip } with a + b + +function subtract (const a : int ; const b : int) : int is + block { skip } with a - b + +function main (const p : action ; const s : int) : (list(operation) * int) is + block {skip} with ((nil : list(operation)), + case p of + | Increment n -> add(s, n) + | Decrement n -> subtract(s, n) + end) diff --git a/gitlab-pages/variables.pp.ligo b/gitlab-pages/variables.pp.ligo new file mode 100644 index 000000000..9fbc65d58 --- /dev/null +++ b/gitlab-pages/variables.pp.ligo @@ -0,0 +1,60 @@ +# 1 "examples/variables.ligo" +# 1 "" +# 1 "" +# 31 "" +# 1 "/usr/include/stdc-predef.h" 1 3 4 + +# 17 "/usr/include/stdc-predef.h" 3 4 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +# 32 "" 2 +# 1 "examples/variables.ligo" +const four : int = 4; +const name : string = "John Doe"; + +function main (const p : unit ; const s : int) : (list(operation) * int) is + block {skip} with ((nil : list(operation)), s) diff --git a/gitlab-pages/website/README.md b/gitlab-pages/website/README.md new file mode 100644 index 000000000..f3da77ff3 --- /dev/null +++ b/gitlab-pages/website/README.md @@ -0,0 +1,193 @@ +This website was created with [Docusaurus](https://docusaurus.io/). + +# What's In This Document + +* [Get Started in 5 Minutes](#get-started-in-5-minutes) +* [Directory Structure](#directory-structure) +* [Editing Content](#editing-content) +* [Adding Content](#adding-content) +* [Full Documentation](#full-documentation) + +# Get Started in 5 Minutes + +1. Make sure all the dependencies for the website are installed: + +```sh +# Install dependencies +$ yarn +``` +2. Run your dev server: + +```sh +# Start the site +$ yarn start +``` + +## Directory Structure + +Your project file structure should look something like this + +``` +my-docusaurus/ + docs/ + doc-1.md + doc-2.md + doc-3.md + website/ + blog/ + 2016-3-11-oldest-post.md + 2017-10-24-newest-post.md + core/ + node_modules/ + pages/ + static/ + css/ + img/ + package.json + sidebar.json + siteConfig.js +``` + +# Editing Content + +## Editing an existing docs page + +Edit docs by navigating to `docs/` and editing the corresponding document: + +`docs/doc-to-be-edited.md` + +```markdown +--- +id: page-needs-edit +title: This Doc Needs To Be Edited +--- + +Edit me... +``` + +For more information about docs, click [here](https://docusaurus.io/docs/en/navigation) + +## Editing an existing blog post + +Edit blog posts by navigating to `website/blog` and editing the corresponding post: + +`website/blog/post-to-be-edited.md` +```markdown +--- +id: post-needs-edit +title: This Blog Post Needs To Be Edited +--- + +Edit me... +``` + +For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog) + +# Adding Content + +## Adding a new docs page to an existing sidebar + +1. Create the doc as a new markdown file in `/docs`, example `docs/newly-created-doc.md`: + +```md +--- +id: newly-created-doc +title: This Doc Needs To Be Edited +--- + +My new content here.. +``` + +1. Refer to that doc's ID in an existing sidebar in `website/sidebar.json`: + +```javascript +// Add newly-created-doc to the Getting Started category of docs +{ + "docs": { + "Getting Started": [ + "quick-start", + "newly-created-doc" // new doc here + ], + ... + }, + ... +} +``` + +For more information about adding new docs, click [here](https://docusaurus.io/docs/en/navigation) + +## Adding a new blog post + +1. Make sure there is a header link to your blog in `website/siteConfig.js`: + +`website/siteConfig.js` +```javascript +headerLinks: [ + ... + { blog: true, label: 'Blog' }, + ... +] +``` + +2. Create the blog post with the format `YYYY-MM-DD-My-Blog-Post-Title.md` in `website/blog`: + +`website/blog/2018-05-21-New-Blog-Post.md` + +```markdown +--- +author: Frank Li +authorURL: https://twitter.com/foobarbaz +authorFBID: 503283835 +title: New Blog Post +--- + +Lorem Ipsum... +``` + +For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog) + +## Adding items to your site's top navigation bar + +1. Add links to docs, custom pages or external links by editing the headerLinks field of `website/siteConfig.js`: + +`website/siteConfig.js` +```javascript +{ + headerLinks: [ + ... + /* you can add docs */ + { doc: 'my-examples', label: 'Examples' }, + /* you can add custom pages */ + { page: 'help', label: 'Help' }, + /* you can add external links */ + { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' }, + ... + ], + ... +} +``` + +For more information about the navigation bar, click [here](https://docusaurus.io/docs/en/navigation) + +## Adding custom pages + +1. Docusaurus uses React components to build pages. The components are saved as .js files in `website/pages/en`: +1. If you want your page to show up in your navigation header, you will need to update `website/siteConfig.js` to add to the `headerLinks` element: + +`website/siteConfig.js` +```javascript +{ + headerLinks: [ + ... + { page: 'my-new-custom-page', label: 'My New Custom Page' }, + ... + ], + ... +} +``` + +For more information about custom pages, click [here](https://docusaurus.io/docs/en/custom-pages). + +# Full Documentation + +Full documentation can be found on the [website](https://docusaurus.io/). diff --git a/gitlab-pages/website/blog/2016-03-11-blog-post.md b/gitlab-pages/website/blog/2016-03-11-blog-post.md new file mode 100644 index 000000000..cf2ba2960 --- /dev/null +++ b/gitlab-pages/website/blog/2016-03-11-blog-post.md @@ -0,0 +1,18 @@ +--- +title: Blog Title +author: Blog Author +authorURL: http://twitter.com/ +authorFBID: 100002976521003 +--- + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus elementum massa eget nulla aliquet sagittis. Proin odio tortor, vulputate ut odio in, ultrices ultricies augue. Cras ornare ultrices lorem malesuada iaculis. Etiam sit amet libero tempor, pulvinar mauris sed, sollicitudin sapien. + + + +Mauris vestibulum ullamcorper nibh, ut semper purus pulvinar ut. Donec volutpat orci sit amet mauris malesuada, non pulvinar augue aliquam. Vestibulum ultricies at urna ut suscipit. Morbi iaculis, erat at imperdiet semper, ipsum nulla sodales erat, eget tincidunt justo dui quis justo. Pellentesque dictum bibendum diam at aliquet. Sed pulvinar, dolor quis finibus ornare, eros odio facilisis erat, eu rhoncus nunc dui sed ex. Nunc gravida dui massa, sed ornare arcu tincidunt sit amet. Maecenas efficitur sapien neque, a laoreet libero feugiat ut. + +Nulla facilisi. Maecenas sodales nec purus eget posuere. Sed sapien quam, pretium a risus in, porttitor dapibus erat. Sed sit amet fringilla ipsum, eget iaculis augue. Integer sollicitudin tortor quis ultricies aliquam. Suspendisse fringilla nunc in tellus cursus, at placerat tellus scelerisque. Sed tempus elit a sollicitudin rhoncus. Nulla facilisi. Morbi nec dolor dolor. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Cras et aliquet lectus. Pellentesque sit amet eros nisi. Quisque ac sapien in sapien congue accumsan. Nullam in posuere ante. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Proin lacinia leo a nibh fringilla pharetra. + +Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Proin venenatis lectus dui, vel ultrices ante bibendum hendrerit. Aenean egestas feugiat dui id hendrerit. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Curabitur in tellus laoreet, eleifend nunc id, viverra leo. Proin vulputate non dolor vel vulputate. Curabitur pretium lobortis felis, sit amet finibus lorem suscipit ut. Sed non mollis risus. Duis sagittis, mi in euismod tincidunt, nunc mauris vestibulum urna, at euismod est elit quis erat. Phasellus accumsan vitae neque eu placerat. In elementum arcu nec tellus imperdiet, eget maximus nulla sodales. Curabitur eu sapien eget nisl sodales fermentum. + +Phasellus pulvinar ex id commodo imperdiet. Praesent odio nibh, sollicitudin sit amet faucibus id, placerat at metus. Donec vitae eros vitae tortor hendrerit finibus. Interdum et malesuada fames ac ante ipsum primis in faucibus. Quisque vitae purus dolor. Duis suscipit ac nulla et finibus. Phasellus ac sem sed dui dictum gravida. Phasellus eleifend vestibulum facilisis. Integer pharetra nec enim vitae mattis. Duis auctor, lectus quis condimentum bibendum, nunc dolor aliquam massa, id bibendum orci velit quis magna. Ut volutpat nulla nunc, sed interdum magna condimentum non. Sed urna metus, scelerisque vitae consectetur a, feugiat quis magna. Donec dignissim ornare nisl, eget tempor risus malesuada quis. diff --git a/gitlab-pages/website/blog/2017-04-10-blog-post-two.md b/gitlab-pages/website/blog/2017-04-10-blog-post-two.md new file mode 100644 index 000000000..3ab4637bd --- /dev/null +++ b/gitlab-pages/website/blog/2017-04-10-blog-post-two.md @@ -0,0 +1,18 @@ +--- +title: New Blog Post +author: Blog Author +authorURL: http://twitter.com/ +authorFBID: 100002976521003 +--- + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus elementum massa eget nulla aliquet sagittis. Proin odio tortor, vulputate ut odio in, ultrices ultricies augue. Cras ornare ultrices lorem malesuada iaculis. Etiam sit amet libero tempor, pulvinar mauris sed, sollicitudin sapien. + + + +Mauris vestibulum ullamcorper nibh, ut semper purus pulvinar ut. Donec volutpat orci sit amet mauris malesuada, non pulvinar augue aliquam. Vestibulum ultricies at urna ut suscipit. Morbi iaculis, erat at imperdiet semper, ipsum nulla sodales erat, eget tincidunt justo dui quis justo. Pellentesque dictum bibendum diam at aliquet. Sed pulvinar, dolor quis finibus ornare, eros odio facilisis erat, eu rhoncus nunc dui sed ex. Nunc gravida dui massa, sed ornare arcu tincidunt sit amet. Maecenas efficitur sapien neque, a laoreet libero feugiat ut. + +Nulla facilisi. Maecenas sodales nec purus eget posuere. Sed sapien quam, pretium a risus in, porttitor dapibus erat. Sed sit amet fringilla ipsum, eget iaculis augue. Integer sollicitudin tortor quis ultricies aliquam. Suspendisse fringilla nunc in tellus cursus, at placerat tellus scelerisque. Sed tempus elit a sollicitudin rhoncus. Nulla facilisi. Morbi nec dolor dolor. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Cras et aliquet lectus. Pellentesque sit amet eros nisi. Quisque ac sapien in sapien congue accumsan. Nullam in posuere ante. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Proin lacinia leo a nibh fringilla pharetra. + +Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Proin venenatis lectus dui, vel ultrices ante bibendum hendrerit. Aenean egestas feugiat dui id hendrerit. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Curabitur in tellus laoreet, eleifend nunc id, viverra leo. Proin vulputate non dolor vel vulputate. Curabitur pretium lobortis felis, sit amet finibus lorem suscipit ut. Sed non mollis risus. Duis sagittis, mi in euismod tincidunt, nunc mauris vestibulum urna, at euismod est elit quis erat. Phasellus accumsan vitae neque eu placerat. In elementum arcu nec tellus imperdiet, eget maximus nulla sodales. Curabitur eu sapien eget nisl sodales fermentum. + +Phasellus pulvinar ex id commodo imperdiet. Praesent odio nibh, sollicitudin sit amet faucibus id, placerat at metus. Donec vitae eros vitae tortor hendrerit finibus. Interdum et malesuada fames ac ante ipsum primis in faucibus. Quisque vitae purus dolor. Duis suscipit ac nulla et finibus. Phasellus ac sem sed dui dictum gravida. Phasellus eleifend vestibulum facilisis. Integer pharetra nec enim vitae mattis. Duis auctor, lectus quis condimentum bibendum, nunc dolor aliquam massa, id bibendum orci velit quis magna. Ut volutpat nulla nunc, sed interdum magna condimentum non. Sed urna metus, scelerisque vitae consectetur a, feugiat quis magna. Donec dignissim ornare nisl, eget tempor risus malesuada quis. diff --git a/gitlab-pages/website/blog/2017-09-25-testing-rss.md b/gitlab-pages/website/blog/2017-09-25-testing-rss.md new file mode 100644 index 000000000..b7ff8129c --- /dev/null +++ b/gitlab-pages/website/blog/2017-09-25-testing-rss.md @@ -0,0 +1,11 @@ +--- +title: Adding RSS Support - RSS Truncation Test +author: Eric Nakagawa +authorURL: http://twitter.com/ericnakagawa +authorFBID: 661277173 +--- +1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890 + +This should be truncated. + +This line should never render in XML. diff --git a/gitlab-pages/website/blog/2017-09-26-adding-rss.md b/gitlab-pages/website/blog/2017-09-26-adding-rss.md new file mode 100644 index 000000000..eeb4f0477 --- /dev/null +++ b/gitlab-pages/website/blog/2017-09-26-adding-rss.md @@ -0,0 +1,10 @@ +--- +title: Adding RSS Support +author: Eric Nakagawa +authorURL: http://twitter.com/ericnakagawa +authorFBID: 661277173 +--- + +This is a test post. + +A whole bunch of other information. diff --git a/gitlab-pages/website/blog/2017-10-24-new-version-1.0.0.md b/gitlab-pages/website/blog/2017-10-24-new-version-1.0.0.md new file mode 100644 index 000000000..60761c02d --- /dev/null +++ b/gitlab-pages/website/blog/2017-10-24-new-version-1.0.0.md @@ -0,0 +1,8 @@ +--- +title: New Version 1.0.0 +author: Eric Nakagawa +authorURL: http://twitter.com/ericnakagawa +authorFBID: 661277173 +--- + +This blog post will test file name parsing issues when periods are present. diff --git a/gitlab-pages/website/core/Footer.js b/gitlab-pages/website/core/Footer.js new file mode 100644 index 000000000..47c8017e8 --- /dev/null +++ b/gitlab-pages/website/core/Footer.js @@ -0,0 +1,104 @@ +/** + * Copyright (c) 2017-present, Facebook, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +const React = require('react'); + +class Footer extends React.Component { + docUrl(doc, language) { + const baseUrl = this.props.config.baseUrl; + const docsUrl = this.props.config.docsUrl; + const docsPart = `${docsUrl ? `${docsUrl}/` : ''}`; + const langPart = `${language ? `${language}/` : ''}`; + return `${baseUrl}${docsPart}${langPart}${doc}`; + } + + pageUrl(doc, language) { + const baseUrl = this.props.config.baseUrl; + return baseUrl + (language ? `${language}/` : '') + doc; + } + + render() { + return ( + + ); + } +} + +module.exports = Footer; diff --git a/gitlab-pages/website/package.json b/gitlab-pages/website/package.json new file mode 100644 index 000000000..e2dbb5afb --- /dev/null +++ b/gitlab-pages/website/package.json @@ -0,0 +1,14 @@ +{ + "scripts": { + "examples": "docusaurus-examples", + "start": "docusaurus-start", + "build": "docusaurus-build", + "publish-gh-pages": "docusaurus-publish", + "write-translations": "docusaurus-write-translations", + "version": "docusaurus-version", + "rename-version": "docusaurus-rename-version" + }, + "devDependencies": { + "docusaurus": "^1.9.0" + } +} diff --git a/gitlab-pages/website/pages/en/help.js b/gitlab-pages/website/pages/en/help.js new file mode 100644 index 000000000..2b790e460 --- /dev/null +++ b/gitlab-pages/website/pages/en/help.js @@ -0,0 +1,54 @@ +/** + * Copyright (c) 2017-present, Facebook, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +const React = require('react'); + +const CompLibrary = require('../../core/CompLibrary.js'); + +const Container = CompLibrary.Container; +const GridBlock = CompLibrary.GridBlock; + +function Help(props) { + const {config: siteConfig, language = ''} = props; + const {baseUrl, docsUrl} = siteConfig; + const docsPart = `${docsUrl ? `${docsUrl}/` : ''}`; + const langPart = `${language ? `${language}/` : ''}`; + const docUrl = doc => `${baseUrl}${docsPart}${langPart}${doc}`; + + const supportLinks = [ + { + content: `Learn more using the [documentation on this site.](${docUrl( + 'doc1.html', + )})`, + title: 'Browse Docs', + }, + { + content: 'Ask questions about the documentation and project', + title: 'Join the community', + }, + { + content: "Find out what's new with this project", + title: 'Stay up to date', + }, + ]; + + return ( +
+ +
+
+

Need help?

+
+

This project is maintained by a dedicated group of people.

+ +
+ +
+ ); +} + +module.exports = Help; diff --git a/gitlab-pages/website/pages/en/index.js b/gitlab-pages/website/pages/en/index.js new file mode 100644 index 000000000..eed4e000e --- /dev/null +++ b/gitlab-pages/website/pages/en/index.js @@ -0,0 +1,251 @@ +/** + * Copyright (c) 2017-present, Facebook, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +const React = require('react'); + +const CompLibrary = require('../../core/CompLibrary.js'); + +const MarkdownBlock = CompLibrary.MarkdownBlock; /* Used to read markdown */ +const Container = CompLibrary.Container; +const GridBlock = CompLibrary.GridBlock; + +class HomeSplash extends React.Component { + render() { + const {siteConfig, language = ''} = this.props; + const {baseUrl, docsUrl} = siteConfig; + const docsPart = `${docsUrl ? `${docsUrl}/` : ''}`; + const langPart = `${language ? `${language}/` : ''}`; + const docUrl = doc => `${baseUrl}${docsPart}${langPart}${doc}`; + + const SplashContainer = props => ( +
+
+
{props.children}
+
+
+ ); + + const Logo = props => ( +
+ Project Logo +
+ ); + + const ProjectTitle = () => ( +

+ {siteConfig.title} + {siteConfig.tagline} +

+ ); + + const PromoSection = props => ( +
+
+
{props.children}
+
+
+ ); + + const Button = props => ( + + ); + + return ( + + {/* */} +
+ + + + + +
+ + ); + } +} + +class Index extends React.Component { + render() { + const {config: siteConfig, language = ''} = this.props; + const {baseUrl} = siteConfig; + + const Block = props => ( + + + + ); + + const FeatureCallout = () => ( +
+

Feature Callout

+ These are features of this project +
+ ); + + const TryOut = () => ( + + {[ + { + content: + 'To make your landing page more attractive, use illustrations! Check out ' + + '[**unDraw**](https://undraw.co/) which provides you with customizable illustrations which are free to use. ' + + 'The illustrations you see on this page are from unDraw.', + image: `${baseUrl}img/undraw_code_review.svg`, + imageAlign: 'left', + title: 'Wonderful SVG Illustrations', + }, + ]} + + ); + + const Description = () => ( + + {[ + { + content: + 'This is another description of how this project is useful', + image: `${baseUrl}img/undraw_note_list.svg`, + imageAlign: 'right', + title: 'Description', + }, + ]} + + ); + + const LearnHow = () => ( + + {[ + { + content: + 'Each new Docusaurus project has **randomly-generated** theme colors.', + image: `${baseUrl}img/undraw_youtube_tutorial.svg`, + imageAlign: 'right', + title: 'Randomly Generated Theme Colors', + }, + ]} + + ); + + const Features = () => ( + + {[ + { + content: 'Write in PascaLIGO (pascal-like syntax) or CameLIGO (caml-like syntax). If you know OCaml, you can also add your own syntax.', + image: ``, + imageAlign: 'top', + title: 'Syntax Agnostic', + }, + { + content: 'Write types, then code, and benefit from the safety coming from type systems.', + image: ``, + imageAlign: 'top', + title: 'Strong Type System', + }, + { + content: 'With Granary, you can use LIGO as a lib from NodeJS.', + image: ``, + imageAlign: 'top', + title: 'Easy Integration', + } + ]} + + ); + + const Roadmap = () => ( +
+ + {[ + { + content: + "

June 2019

" + + "
    " + + "
  • First public release
    • " + + "
  • PascaLIGO and CameLIGO syntaxes
    • " + + "
  • Docs and Tutorials
    • " + + "
  • Integration testing in ReasonML/JS with Granary
    • " + + "
" + + "

July 2019

" + + "
    " + + "
  • Try LIGO online editor
    • " + + "
  • Unit testing toolkit
    • " + + "
  • ReasonLIGO syntax support
    • " + + "
  • Repository with best practices & patterns for LIGO
    • " + + "
" + + "

August 2019

" + + "" + + "Long term plans will be announced soon" + + "", + image: ``, + imageAlign: 'right', + title: 'Roadmap', + }, + ]} + +
+ ); + + const Showcase = () => { + if ((siteConfig.users || []).length === 0) { + return null; + } + + const showcase = siteConfig.users + .filter(user => user.pinned) + .map(user => ( + + {user.caption} + + )); + + const pageUrl = page => baseUrl + (language ? `${language}/` : '') + page; + + return ( +
+

Who is Using This?

+

This project is used by all these people

+
{showcase}
+ {/* */} +
+ ); + }; + + return ( +
+ +
+ + + {/* */} + {/* {/* */} + {/* */} + {/* */} + {/* */} +
+
+ ); + } +} + +module.exports = Index; diff --git a/gitlab-pages/website/pages/en/users.js b/gitlab-pages/website/pages/en/users.js new file mode 100644 index 000000000..039dc39ff --- /dev/null +++ b/gitlab-pages/website/pages/en/users.js @@ -0,0 +1,48 @@ +/** + * Copyright (c) 2017-present, Facebook, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +const React = require('react'); + +const CompLibrary = require('../../core/CompLibrary.js'); + +const Container = CompLibrary.Container; + +class Users extends React.Component { + render() { + const {config: siteConfig} = this.props; + if ((siteConfig.users || []).length === 0) { + return null; + } + + const editUrl = `${siteConfig.repoUrl}/edit/master/website/siteConfig.js`; + const showcase = siteConfig.users.map(user => ( + + {user.caption} + + )); + + return ( +
+ +
+
+

Who is Using This?

+

This project is used by many folks

+
+
{showcase}
+

Are you using this project?

+ + Add your company + +
+ +
+ ); + } +} + +module.exports = Users; diff --git a/gitlab-pages/website/sidebars.json b/gitlab-pages/website/sidebars.json new file mode 100644 index 000000000..896941f78 --- /dev/null +++ b/gitlab-pages/website/sidebars.json @@ -0,0 +1,7 @@ +{ + "docs": { + "Setup": ["setup-installation"], + "Language Basics": ["language-basics-variables", "language-basics-functions", "language-basics-entrypoints", "language-basics-operators"], + "API": ["api-cli-commands"] + } +} diff --git a/gitlab-pages/website/siteConfig.js b/gitlab-pages/website/siteConfig.js new file mode 100644 index 000000000..5ea8e645d --- /dev/null +++ b/gitlab-pages/website/siteConfig.js @@ -0,0 +1,104 @@ +/** + * Copyright (c) 2017-present, Facebook, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ + +// See https://docusaurus.io/docs/site-config for all the possible +// site configuration options. + +// List of projects/orgs using your project for the users page. +const users = [ + { + caption: 'User1', + // You will need to prepend the image path with your baseUrl + // if it is not '/', like: '/test-site/img/image.jpg'. + image: '/img/undraw_open_source.svg', + infoLink: 'https://www.facebook.com', + pinned: true, + }, +]; + +const siteConfig = { + title: 'LIGO', // Title for your website. + tagline: 'LIGO is a statically typed high-level smart-contract language that compiles down to Tezos. It seeks be easy to use, extensible and safe.', + url: 'https://your-docusaurus-test-site.com', // 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: 'marigold', + // 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: [], + headerLinks: [ + {doc: 'setup-installation', label: 'Docs'}, + {doc: 'api-cli-commands', label: 'CLI'}, + ], + + // If you have users set above, you add it here: + users, + + /* path to images for header/footer */ + headerIcon: 'img/favicon.ico', + footerIcon: 'img/favicon.ico', + favicon: 'img/favicon.ico', + + /* Colors for website */ + colors: { + primaryColor: '#479e10', + secondaryColor: '#316e0b', + }, + + /* Custom fonts for website */ + /* + fonts: { + myFont: [ + "Times New Roman", + "Serif" + ], + myOtherFont: [ + "-apple-system", + "system-ui" + ] + }, + */ + + // This copyright info is used in /core/Footer.js and blog RSS/Atom feeds. + copyright: `Copyright © ${new Date().getFullYear()} Marigold`, + + highlight: { + // Highlight.js theme to use for syntax highlighting in code blocks. + theme: 'default', + }, + + // Add custom scripts here that would be placed in