Skip to content
This repository was archived by the owner on Jan 17, 2021. It is now read-only.

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ferreiro authored May 7, 2019
1 parent 9b287f6 commit 8653c8e
Showing 1 changed file with 57 additions and 0 deletions.
57 changes: 57 additions & 0 deletions packages/ferreiro-server/web/content/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
## Biography data type

I created a system to define my own datatypes so the view can parse and behave differently given the data type.

Attributes:

* icon*: the name of the icon
* body*: text or description of the entry.
* type: my own data types for each entry in the description.
* entry: a single line.
* bullets: 1 or more entries.
* warning: a special type, when you want to highlight something on your entry.
Warnings have extra attributes:

```js
link: {
url: "http://test.dailyfocus.io",
target: "blank"
}
```

(*) means this attribute can be nullable. In this case, just set the value to null.

``` js
description: [
{
type: "warning",
icon: null,
body: "Test out my work! http://test.dailyfocus.io",
link: {
url: "http://test.dailyfocus.io",
target: "blank"
}
},
{
type: "entry",
icon: "ion-chatbox-working",
body: "Bachelor's degree in Computer Science."
},
{
type: "bullets",
icon: null,
body: [
{
type: "entry",
icon: "ion-chatbox-working",
body: "CS 61BL: Data Structures and Programming Methodology."
},
{
type: "entry",
icon: null,
body: "COLWRIT 9: Conflict Resolution and Communication Skills."
}
]
}
]
```

0 comments on commit 8653c8e

Please sign in to comment.