Document name and folder
To change the name of a pad you can use the rename button (nail polish picto) in manage view.
To move a pad into a folder, use the same renaming path and add the name of the folder in front of the pad name followed by with 2 colons (punctuation)
folder-name::pad-name.md
To move one or many pads from one directory to another you have for now to rename each of them individually.
Document header
To work properly, it is necessary to fill in a certain amount of information related to the edited text. The beginning of the pad is thus composed of a series of keys and values.
Title: Looming Score
Date: 2019-09-16
Authors: Lilia
Sina
Types: draft
- Title
- Decide here for a proper title. This is the one that will appear in various listings
- Date
- An ISO formatted date string, like
2019-03-22
- Authors
- Write the name(s) of the main writer(s) of the pad or name of the author of the text if it is an existing text.
- Type
- Pick here one or more words of the type list:
report
, scribble
, note
, sticky
, note
, draft
, memo
, meeting, notes
, report
,transcript
, letter
, message
, document
, book
, collection
, library
, archive
, drawing
, list
, poetry
, diary
,manifesto
, tutorial
, theory
, manifesto
, litterature
, fable
, fiction
, nonfiction
, manual
, score
.
Keywords
You can freely mark any word in your document body (not the document header) to appear in the general index. To do so, use the `%%aa:keyword::The keyword%%` syntax. In the example below, the word "collection" is referenced as a keyword:
Here a consize %%aa:keyword::collection%% of bugs.
In case you'd like to index a different word than the one that is in the text, you can use the `|` sign. In the exemple below, the word "collection" appears in the text, but it is the word "collecting" that is indexed.
Here a consize %%aa:keyword::collecting|collection%% of bugs.
This is especially useful for names, example:
%%aa:keyword :: Sherry Turkle | Turkle's%% Second Self was an early book on the social aspects of computation.
Body
Markdown is a set of writing conventions that allows you to easily structure your writings, a kind of HTML shortcut.
New paragraph
Jump one line
to start a new paragraph
Pre-formatted blocks
if you are wrinting code or poetry, you will ikely want to preserve line breaks. To do so, prefix each line (including line breaks) with 4 spaces:
How doth the little crocodile
Improve his shining tail,
And pour the waters of the Nile
On every golden scale!
If you want to make a line break within a regular paragraph, place two empty spaces at the end of a line.
Forcing a line-break
Next line in the list
If you want to make multiple line breaks within a regular paragraph, use HTML `<br>` line breaks`.
Forcing a line-break<br><br>
Jump 2 lines
Titles
# Header 1
## Header 2
### Header 3
Emphasis
*italic* **bold**
Links
Online :
[example](http://url.com/"something")
Internal :
[example](page-name.md)
Pictures, sounds and videos
— Import it with the media import button.
— Show online pictures (titles are optional):
![alt text](url "Titre")
— Embed sounds and videos
Paste your PeerTube, YouTube, Vimeo or Soundcloud share embed link.
Blockquotes
Sister Corita Kent rule #1:
> Find a place you trust, and then try trusting it for awhile.
Blockquotes can be nested (a blockquote in a blocquote) like this:
> This is the first lever of quoting.
>
> > This is nested blockquote.
Codes
Appuyez sur la touche `<Ctrl>`
Horizontal rules
Minimum three asterisks:
* * *
Lists
Ordered without paragraphs:
1. garlic;
2. oregano
Without order with paragraphs :
* funk;
* grindcore.
List markers must be followed by one or more spaces or a tab.
More
To learn more about markdown syntax please visit the markdown cheatsheet of Adam Pritchard