Updated README
This commit is contained in:
parent
675308db50
commit
20b4935ed7
91
README.md
91
README.md
@ -1,18 +1,22 @@
|
|||||||
# Event Calendar Plugin for Joplin
|
# Event Calendar Plugin for Joplin
|
||||||
|
|
||||||
This is a plugin for the Joplin note-taking app.
|
This is a plugin for the [Joplin](https://joplinapp.org/) note-taking app.
|
||||||
|
|
||||||
It creates a calendar view of events that have been specified using the [YAML](https://yaml.org/) syntax within a fenced block.
|
It creates a calendar view of events that have been specified using the [YAML](https://yaml.org/) syntax within a fenced block.
|
||||||
|
|
||||||
*Example Day view*
|
- Organises events into "groupings"; you can group events by **day**, **week** or by **month**
|
||||||
|
- Focus is on readability and simplicity of content, which is why the **YAML** is simple in structure
|
||||||
|
|
||||||
|
###### Example Day view
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
## About
|
## Features
|
||||||
|
|
||||||
- Ability to change the group view; you can group events by day, week or by month
|
- A grouping that contains no events will show the **date** (day grouping), **week number** (week grouping), or **month** (month grouping)
|
||||||
- Events can be specified in any order
|
- If a grouping falls under the **current date**, it is highlighted in yellow
|
||||||
- Events can be given an icon
|
- Events can be specified in **any order**
|
||||||
- Focus is on readability and simplicity of content, which is why the YAML is simple in structure
|
- Events can be assigned an **icon** 🎁 such as an emoji
|
||||||
|
|
||||||
## How to use
|
## How to use
|
||||||
|
|
||||||
@ -32,53 +36,46 @@ Create a fenced block with the **codetype** `joplin-plugin-event-calendar`
|
|||||||
|
|
||||||
Events are specified using the YAML syntax, with the following keys:
|
Events are specified using the YAML syntax, with the following keys:
|
||||||
|
|
||||||
### Group
|
### group:
|
||||||
|
|
||||||
> **group**
|
|
||||||
>
|
|
||||||
> - _**optional**_
|
|
||||||
> - **accepts** : `day`, `week`, `month`, `d`, `w`, `m`
|
|
||||||
> - **default** `day`
|
|
||||||
>
|
|
||||||
> Sets the grouping for the view
|
> Sets the grouping for the view
|
||||||
|
> - _**optional**_
|
||||||
|
> - **default** `day`
|
||||||
|
> - **accepts** : `day`, `week`, `month`, `d`, `w`, `m`
|
||||||
|
|
||||||
### Each event has the following properties
|
### events:
|
||||||
|
> Each individual event is a list with its own properties
|
||||||
> **date**
|
|
||||||
>
|
>
|
||||||
> - **required**
|
> > **date:**
|
||||||
> - **accepts** : _yyyy-mm-dd_ or _mm-dd-yyyy_
|
> >
|
||||||
|
> > The date of the event
|
||||||
|
> > - **required**
|
||||||
|
> > - **accepts** : _yyyy-mm-dd_ or _mm-dd-yyyy_
|
||||||
>
|
>
|
||||||
> The date of the event
|
> > **icon:**
|
||||||
|
> >
|
||||||
> **icon**
|
> > - **optional**
|
||||||
|
> > - **accepts** : _string_
|
||||||
|
> >
|
||||||
|
> > The icon for the event
|
||||||
>
|
>
|
||||||
> - **optional**
|
> > **title**
|
||||||
> - **accepts** : _string_
|
> >
|
||||||
|
> > The title or heading of the event
|
||||||
|
> > - **required**
|
||||||
|
> > - **accepts** : _string_
|
||||||
>
|
>
|
||||||
> The icon for the event
|
> > **text:**
|
||||||
|
> >
|
||||||
> **title**
|
> > A more detailed description of the event
|
||||||
|
> > - **optional**
|
||||||
|
> > - **accepts** : _string_
|
||||||
>
|
>
|
||||||
> - **required**
|
> > **bgColor:**
|
||||||
> - **accepts** : _string_
|
> >
|
||||||
>
|
> > The background color for the event container
|
||||||
> The title or heading of the event
|
> > - **optional**
|
||||||
|
> > - **default** : random
|
||||||
> **text**
|
> > - **accepts** : _string_
|
||||||
>
|
|
||||||
> - **optional**
|
|
||||||
> - **accepts** : _string_
|
|
||||||
>
|
|
||||||
> A more detailed description of the event
|
|
||||||
|
|
||||||
> **bgColor**
|
|
||||||
>
|
|
||||||
> - **optional**
|
|
||||||
> - **accepts** : _string_
|
|
||||||
> - **default** : random
|
|
||||||
>
|
|
||||||
> The background color for the event container
|
|
||||||
|
|
||||||
## Acknowledgements
|
## Acknowledgements
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user