You should have been given read access to the English version of the site to view the files. They are now written in a text format called markdown .md (The previous method was .org file)
Encoding of file – UTF-8
Note: It is important that they are saved in UTF-8 encoding with Unix line endings.
When you save a file, you should see the above option at the bottom.
Once the files are completed, they can be added to our repository – see our page on Using Seafile to add books
Using markdown
To use markdown, you can use an app which enables a preview of how the code will look – useful for avoiding mistakes.
- Markdown editor (Typora) for windows
- Macdown for mac
If you are not able to use markdown, and want to update the library using a .txt file, please delete the .md file. The library will automatically re-create a .md file from .txt.
Basic structure of Markdown
It is helpful to look at English pages, the syntax will be the same.
Book main properties
Use YAML block at the beginning of the file, with format:
---
property_name: property_value
...
---
Example:
—
author: Sri Chinmoy
language: en (change to foreign language if appropriate e.g. :fr, de)
book-number: 1487
year: 2004
publisher: Agni Press
cite-key: PBR
genre: talk
—
Each individual unit, has a cite-key, which will be like this
Cite-key
### 1. What is meditation?
<!– properties
genre: discourse
cite-key: MGD-1
–>
### 2, Question: What is the aim of meditation?
<!– properties
genre: qa
cite-key: MGD-2
–>
### 3, Meditation
<!– properties
genre: discourse
cite-key: MGD-3
–>
Examples of markdown syntax for library.
Headings and sub-headings
- H2 ##
- H3 ###
- H4 ####
Paragraphs
For ordinary paragraphs. just leave a blank line between text
For a hard line break, that is, forcing a new line, just put a backslash followed by a new line.
Example:
Sri Chinmoy \
New York, 1995
Italics
To make italics we use _before and after text to be italicised_
Example
A quote from _Beyond Within_ by Sri Chinmoy
Poem syntax
If it is poetry, it should go in a triple ``` block.
Example
```
My Lord,
I came to You with empty hands,
But You have discovered
My empty heart, too.
```
A verse block does not mean “this is poetry”, but rather “treat this block exactly as it is”.
QUOTE
To show a quote we use > (Previous [BEGIN_QUOTE]
Example
The poet sang:
> I slept and dreamed that life was Beauty. \
> I woke and found that life was Duty.
> – John Keats
Listing syntax
If there is a listing in a book (e.g. using dots), the Store uses a hyphen (one single “minus” sign -).
- item 1
- item 2
- etc
No spacing between the items is needed.
Endnote (footnote) syntax
1. A single unit
## [unit_number]. Unit title[^unit_number]
Body of unit …
[^unit_number]: unit_number. Text of endnote.
“`
Example:
### 2. I have offered, I have received[^2]
... Body of unit ...
[^2]: 2. International Fair of Philosophies and Religions, Montreal, 6 April 1978.
2. To more units
### 13. Question: Text of question[^13-18]
…body of text…
[^13-18]: 13-18. 16 and 26 November 1976.
Fleuron syntax
\fleuron
[Previous {{{fleuron}}}]:
End of a file
Although not indispensable, it is important to have a newline (blank line) at the end of a file.
Images
The images should be present in a ‘media’ folder at the same level as the .md file.
The syntax is:
Example:
End of a file
Although not indispensable, it is important to have a newline (blank line) at the end of a file.
Lists
Use (number)(dot) at the beginning of each item
Example:
1. October 23, 1999 Central Park New York, USA
5,000 attended
2. November 17, 1999 York College Queens, New York, USA
(After the weightlifting demonstration) 500 attended
3. November 20, 1999 Corel Centre Ottawa, Canada
7,000 attended