From 8e0f9f265193b711d6f1debf69815b3e08719ddc Mon Sep 17 00:00:00 2001 From: Pocco81 Date: Wed, 25 May 2022 12:15:19 -0500 Subject: [PATCH] added index --- docs/README.md | 227 ++----------------------------------------------- 1 file changed, 8 insertions(+), 219 deletions(-) diff --git a/docs/README.md b/docs/README.md index 4a4c822..32166eb 100644 --- a/docs/README.md +++ b/docs/README.md @@ -22,222 +22,11 @@ Catppuccin is a community-driven pastel theme that aims to be the middle ground between low and high contrast themes. It consists of 4 soothing warms palette with 26 eye-candy colors each, perfect for coding, designing, and much more! In addition, this repository tracks the development of the actual color palette, organization-wide assets, resources and code samples for maintainers/developers.

-### 🎏 Koy Lang - -Koy is designed to be a minimal, simple and intuitive data serialization language; easy for you, your dog and your average 5 year-old. It has a small set of symbols, not too many rules and only one singular statement. Its lack of complexity makes it the perfect language for your project! easy to implement, debug and modularize. - -Go ahead and check out the [Conventions](https://github.com/Pocco81/koy-lang/blob/main/docs/conventions.md) to learn about the generalities of the language! if you end up liking it, consider checking out the [Specs sheet](https://github.com/Pocco81/koy-lang/blob/main/docs/specs.md) and the [Style Guide](https://github.com/Pocco81/koy-lang/blob/main/docs/style-guide.md). - -  - -### 📚 Cheat sheet - -
- Cheat sheet for symbols -  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Symbols Function Example
// Single-line comment - -``` -// hello world! -``` - -
/**/ Multi-line comment - -``` -/* - This is a multi-line comment and - you are watcing Disney channel! -*/ -``` - -
: Set a key, followed by its data type (optional) and then the value. To define a literal key put it between single quotes ('') - -``` -hello: "world!" - -// specifying data type -temperature:int 12.23 -``` - -
${} Call a variable - -``` -// simple usage -name: "Michael Theodor Mouse" -hello: "Good evening ${name}" - -// with arrays (using the `.` notation) -user: { - name: "Michael", - surnames: "Theodor Mouse" -} -hi: "Good morning ${user.name}" -``` - -
"" Define a normal string - -``` -hello: "world" -``` - -
""" """ Define a multi-line string - -``` -hello: """My name is - Michael Theodor Mouse, but - you can call me Peter. -""" -``` - -
'' Define a literal value - -``` -weird_path: 'pc/\fds!fd/\&24324%!@' -``` - -
[] Define an array - -``` -hosts: [ "omega", "alpha", "gama" ] -``` - -
{} Define an object - -``` -user: { - name: "Michael Theodor Mouse", - age: 92 -} -``` - -
import Import other .koy files - -``` -// single import -import "./directory/settings.koy" - -// multiple imports -import { - "./directory/user0.koy", - "./directory/user1.koy", - "./directory/user2.koy" -} -``` - -
<< Overwrite values from objects - -``` -user: { - name: "Michael Theodor Mouse", - age: 93 -} - -laptop: { - name: "Lenovo Thinkpad", - owner: ${user} << { - name: "Dominic Toretto" - } -} -``` - -
- -
-
- -
- Cheat sheet for rules -  - -
-
- -
- Example .koy file using every feature -  - -
-
- -& +### ðŸŠī Index + ++ [Library Implementations](#-library-implementations) ++ [IDE/DE Support](#%EF%B8%8F-idede-support) ++ [Documentation](#-documentation) ++ [ToDo List](#-todo-list) ++ [FAQ](#-faq) ++ [License](#-license)