Introduce

The structure of a Noat.Cards repository will like a book format. Book structure will content many chapters which describe small part of the book. The Noat.Cards repository is also the same.

Bellow is simple knowledge structure.

By apply the defined structure of abook to Noat.Cards knowledge repo. We can easy on organizing the structure of a big knowledge topic.

Deck file header

To seperate the Noat.Cards* MarkDown deck file with another markdown file, we define a header markup like bellow:

+++

noatcards = true
isdraft = false

+++

The header is must push in the beginning of the deck file (*.md). The noat.cards system will use the variable noatcards and draft to determine whether or not import the deck file to database.

By this formatting, we can easy to porting an existed repository to Noat.Cards repository. By adding a deck file or editing the existed content markdown file.

Deck name

Format:

# <This is Deck name>
// or 
## <This is Deck name>

Example

# Hello world, deck file
// or
## Hello world, deck File

Basically, the highest heading level is deck name. The lower heading level is card name

Card types

Noat.Cards support many of card types: including:

• Flash Card: A card bearing information on both sides, which is intended to be used as an aid in memorization
• Note Card: A card contains an arbitrary amount of information embodied in text, graphics, images, or some other editable substance
• Quiz Card: A card contents a quiz question and let people select what are the correct options

Flask card formatting

Format

## <Card Name>

// <Your front card content>

---- // seperated symbol between front card and back card

< Your back card >

Example

## hello world

this is my front card content

----

this is my back card content

Note card formatting

The same with flash card but it doesn’t have the separated front-back symbol ----

Format

## <Note card tile>

<Note card content >

Example

## Hello world

Welcome to noat.cards

Quiz card formatting

Quiz Card is special card which used to review how well you know about a fact by question. And You have to answer the question by select the correct answers.

Format

## <Questions about a fact >
<Description about the fact>

[ ] Option 1     // wrong answer
[x] Option 2    // correct answer
[ ] Option 3     // wrong answer
[x] Option 4    // correct answer
[ ] Option 5     // wrong answer

Example

## What is capital of Vietnam
Vietnam is country on SEA

[] Ho Chi Minh city
[x] Ha Noi
[] Da Nang
[] Binh Duong

The system will create quiz card and let user select the answer. After a specific timeout, the system will return the result to user

Example for full deck file (*.md)

+++
noatcards = True
isdraft = False
+++

# this is example deck

## What is capital of Vietnam
this is quiz card

Vietnam is country on SEA

[ ] Ho Chi Minh city
[x] Ha Noi
[ ] Da Nang
[ ] Binh Duong

## Hello world
this is note card
Welcome to noat.cards

## hello world
this is flash card
this is my front card content

----

this is my back card content