Help

Penip

This project can be followed at:

https://www.penip.com/Penip/help

This work is licensed under a Creative Commons Attribution 4.0 International License.
Contents

I Getting Started 6

1 Penip Basics 7

2 Project Types 8

3 Versions and Tags 9

II Writing 12

4 Markdown Cheatsheet 13
Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

5 H1 14
H2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

6 Alt-H1 15
Alt-H2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Emphasis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Code and Syntax Highlighting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Footnotes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Escaping Control Characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Blockquotes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Inline HTML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Horizontal Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Line Breaks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Youtube videos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

7 Sections and Folders 23

8 MathJax 24
Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

3
 4

9 Keyboard Shortcuts 25

10 Code block syntax highlighting 26

11 YAML Front Matter 27

III Publishing 28

12 Publishing Overview 29

13 Publishing Options 31

14 Cover Images 32

IV Working Oine 33

15 Working with Git 34

16 Organizing Contents 40

17 Generating SSH Keys 41

V Project Management 43

18 Project Labels 44
 5

This is a continually updated guide for all things Penip. New features are added frequently, so no
promises on completeness.
If you cant nd what youre looking for here, send an email to support@penip.com or start a
discussion. To suggest a feature or improvement, start a feedback discussion.
 Part I

Getting Started

6
1 Penip Basics

Some core concepts of Penip to get you started:

Projects

The project page is the headquarters for you and your collaborators - you can write new content, edit
existing content, invite collaborators, have discussions, browse changes, see project activity, export
your project, and more.

Writing

Youll see Edit buttons across the site. Clicking any of these buttons will take you into the
distraction-free Penip editor, similar to Google Docs and other writing tools. Everything is written
with Markdown. To understand why markdown is awesome for writing, read this.

Versions

Every project has a master version. Whenever you invite somebody to your project, a new version
will automatically be created for them, and all of their changes will be made on their own version.
When a collaborator is ready to submit their changes into the master version, theyll create a Merge
Request.

Merge Requests

A Merge Request is a group of changes to your project. All merge requests go into the master
version. As the project owner, you control the merge requests: you can accept them, ignore them,
and comment on them to suggest changes. When you accept a Merge Request, the master version
of your project will be updated with those changes.

Still confused? Email support@penip.com for help!

7
2 Project Types

There are two types of projects on Penip:

Book

A book project has a collection of les. Each chapter is a separate le. When you export your
project, the les will be combined and turned into a presentable book. With a new book project,
some les are generated to get you started. You can create new les/chapters as needed for your
project.
A book project also comes with a discussion board where anyone working on the project can
participate in conversations about the project. New conversations on dierent topics can be opened
at any time, and old ones that are no longer relevant can be closed.

Document

A document project has a single le, much like a Google Doc or Word document. This type of
project is ideal for short stories and collaborative essays. With longer papers (e.g. a PhD thesis), a
book project is recommended, so that the sections of the paper can be organized into dierent les.
Instead of a discussion board, a document project has a simple unthreaded chat feature.

Public vs. private

When you create a new project, you can choose to make it public or private. A public project can
be discovered by anyone, while a private one can only be seen by people who you explicitly share it
with.

Still confused? Email support@penip.com for help!

8
3 Versions and Tags

Version control is simply means: a way to manage changes over time. If youve ever saved multiple
versions of a document (like a rough draft and nal draft), then youve hacked together your own
version control system. Congrats! The problem with that is that its cumbersome and dicult to
manage, especially for long term projects with multiple collaborators.
Penip handles all of this for you, so you can focus on writing.

Versions

You can think of a version like a copy of the project. Versions change over time, and a Penip
project can have multiple versions. When you create a project, theres only a master version. The
master version is the main version of the project, and only you can make changes to this version.
When collaborators join your project, a new version is created for each of them, automatically. For
example, when your friend Tim joins your project, a new version will be created called tim. When
Tim makes changes to the project, those changes are only made on his version. The master version
isnt updated until he submits his changes for approval.
When a collaborator edits your project, they will see a message like this:

Submitting changes

After a collaborator makes changes on their version, they submit them for your approval, describing
the changes theyve made:

9
 10

Accepting changes

As the project owner, you will be notied of submitted changes via email, with a link to view the
changes. From there, you can choose to accept or reject the changes. If you accept the changes,
the master version of the project will be updated with the new changes. If you reject the changes,
theyll be discarded (but stored in an alternate version for archival purposes).
This is convenient because you can send a project link to your peers, request feedback, and only
integrate the feedback you want to accept - all with the click of a button, in the browser.

Tags

When youre editing your project, you can create tags. You can think of a tag like a checkpoint
or reference point - marking a project in its current state at a specic time. For example, after
youve released the rst version of a book, you can create a version1 tag. You can continue making
updates and changes to your book, but you can always go back to version1 to see how the book
looked at that time.
 11

Create a tag by clicking on the Save icon while editing, then typing a tag name under Tag this
version:

Viewing versions and tags

On a project page, you see the master version by default. You can switch to any version or tag using
a toggle in the bottom right corner. You can also download the project with any version or tag after
youve switched.

Note: this will not display unless there are multiple versions or tags.
Part II

Writing

12
4 Markdown Cheatsheet

Forked from here.

Headers
Emphasis
Lists
Links
Images
Code and Syntax Highlighting
Tables
Footnotes
Blockquotes
Inline HTML
Horizontal Rule
Line Breaks
Escaping Control Characters
Youtube videos

Headers

# H1
## H2
### H3
#### H4
##### H5
###### H6

Alternatively , for H1 and H2 , an underline -ish style:

Alt -H1
======

Alt -H2
------

13
5 H1

H2

H3

H4

H5

H6 Alternatively, for H1 and H2, an underline-ish style:

14
6 Alt-H1

Alt-H2

Emphasis

Emphasis , aka italics , with * asterisks * or _underscores_ .

Strong emphasis , aka bold , with ** asterisks ** or __underscores__ .

Combined emphasis with ** asterisks and _underscores_ **.

Strikethrough uses two tildes . ~~ Scratch this .~~

Emphasis, aka italics, with asterisks or underscores.rr

Strong emphasis, aka bold, with asterisks or underscores.
Combined emphasis with asterisks and underscores.
Strikethrough uses two tildes. Scratch this.

Lists

(In this example, leading and trailing spaces are shown with with dots: )
1. First ordered list item
2. Another item
* Unordered sub -list.
1. Actual numbers don 't matter , just that it 's a number
1. Ordered sub -list
4. And another item.

You can have properly indented paragraphs within list items. Notice the blank line
above , and the leading spaces (at least one , but we 'll use three here to also
align the raw Markdown ).

15
 16

To have a line break without a paragraph , you will need to use two trailing
spaces.
Note that this line is separate , but within the same paragraph.
(This is contrary to the typical GFM line break behaviour , where trailing spaces
are not required .)

* Unordered list can use asterisks

- Or minuses
+ Or pluses

1. First ordered list item

2. Another item

Unordered sub-list.

1. Actual numbers dont matter, just that its a number

2. Ordered sub-list
3. And another item.

You can have properly indented paragraphs within list items. Notice the blank line above, and the
leading spaces (at least one, but well use three here to also align the raw Markdown).
To have a line break without a paragraph, you will need to use two trailing spaces.
Note that this line is separate, but within the same paragraph.
(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)

Unordered list can use asterisks

Or minuses
Or pluses

Links

There are two ways to create links.

[I'm an inline - style link ]( https :// www. google .com)

[I'm an inline - style link with title ]( https :// www. google .com "Google 's Homepage ")

[I'm a reference - style link ][ Arbitrary case - insensitive reference text]

[I'm a relative reference to a repository file ](../ blob/ master / LICENSE )

 17

[You can use numbers for reference - style link definitions ][1]

Or leave it empty and use the [link text itself ]

Some text to show that the reference links can follow later.

[ arbitrary case - insensitive reference text ]: https :// www. mozilla .org
[1]: http :// slashdot .org
[link text itself ]: http :// www. reddit .com

Im an inline-style link
Im an inline-style link with title
Im a reference-style link
Im a relative reference to a repository le
You can use numbers for reference-style link denitions
Or leave it empty and use the link text itself
Some text to show that the reference links can follow later.

Images

Here 's a logo ( hover to see the title text):

Inline - style :
![ alt
text ](/ home/git/image - cache / github .com/adam -p/markdown -here/raw/ master /src/ common / images / icon48p
"Logo Title Text 1")

Reference -style:
![ alt text ][ logo]

[logo ]:
/home/git/image -cache / github .com/adam -p/markdown -here/raw/ master /src/ common / images / icon48png .pdf
"Logo Title Text 2"

Heres a logo (hover to see the title text):

Inline-style:

Reference-style:
 18

Code and Syntax Highlighting

Code blocks are part of the Markdown spec, but syntax highlighting isnt. However, many renderers
like Githubs and Markdown Here support syntax highlighting. Markdown Here supports high-
lighting for dozens of languages (and not-really-languages, like dis and HTTP headers); to see the
complete list, and how to write the language names, see the highlight.js demo page.
Inline `code ` has `back - ticks around ` it.

Inline code has back-ticks around it.

Blocks of code are either fenced by lines with three back-ticks , or are indented with four spaces.
I recommend only using the fenced code blocks theyre easier and only they support syntax high-
lighting.
``` javascript
var s = " JavaScript syntax highlighting ";
alert (s);
```

```python
s = " Python syntax highlighting "
print s
```

```
No language indicated , so no syntax highlighting .
But let 's throw in a <b>tag </b >.
```

var s = " JavaScript syntax highlighting ";

alert (s);

s = " Python syntax highlighting "

print s

No language indicated , so no syntax highlighting in Markdown Here ( varies on

Github ).
But let 's throw in a <b>tag </b >.

(Github Wiki pages dont seem to support syntax highlighting, so the above wont be colourful (the
strings are not red, for example). Try it out in a Markdown Here email or a Github Markdown
README or Github Issue you can preview a new Issue without submitting it.)
Again, to see what languages are available for highlighting, and how to write those language names,
see the highlight.js demo page.
 19

Tables

Tables arent part of the core Markdown spec, but they are part of GFM and Markdown Here supports
them. They are an easy way of adding tables to your email a task that would otherwise require
copy-pasting from another application.
Colons can be used to align columns .

| Tables | Are | Cool |

| ------------- |:-------------:| -----:|
| col 3 is | right - aligned | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |

The outer pipes (|) are optional , and you don 't need to make the raw Markdown line
up prettily . You can also use inline Markdown .

Markdown | Less | Pretty

--- | --- | ---
*Still * | `renders ` | ** nicely **
1 | 2 | 3

Colons can be used to align columns.

Tables Are Cool

col 3 is right-aligned $1600

col 2 is centered $12
zebra stripes are neat $1

The outer pipes (|) are optional, and you dont need to make the raw Markdown line up prettily.
You can also use inline Markdown.

Markdown Less Pretty

Still renders nicely

1 2 3

Footnotes

Footnotes are not supported in standard markdown, but Penip allows footnotes:
Here is a footnote reference [^1].
 20

[^1]: Here is the footnote .

Escaping Control Characters

Sometimes , you need to use plus , minus , underscore , curly and straight braces ,
backticks and others without them being registered as part of Markdown .

In this case , you use backslashes to escape them , like this: \* \_ \- \+ \{ \] \}

\[ \# \` \\

Sometimes, you need to use plus, minus, underscore, curly and straight braces, backticks and others
without them being registered as part of Markdown.
In this case, you use backslashes to escape them, like this: * _ - + { ] } [ # () \

Blockquotes

> Blockquotes are very handy in email to emulate reply text.

> This line is part of the same quote.

Quote break .

> This is a very long line that will still be quoted properly when it wraps. Oh boy
let 's keep writing to make sure this is long enough to actually wrap for
everyone . Oh , you can *put* ** Markdown ** into a blockquote .

Blockquotes are very handy in email to emulate reply text.

This line is part of the same quote.

You may notice that the end of the rst line above needs to have a soft-break achieved by using
shift-enter.
Quote break.

This is a very long line that will still be quoted properly when it wraps. Oh boy lets keep
writing to make sure this is long enough to actually wrap for everyone. Oh, you can put
Markdown into a blockquote.
 21

Inline HTML

You can also use raw HTML in your Markdown, and itll mostly work pretty well.
<dl >
<dt > Definition list </dt >
<dd >Is something people use sometimes .</dd >

<dt > Markdown in HTML </dt >

<dd >Does *not* work ** very ** well. Use HTML <em >tags </em >.</dd >
</dl >

Horizontal Rule

Three or more ...

---

Hyphens

***

Asterisks

___

Underscores

Three or more

Hyphens

Asterisks

Underscores
 22

Line Breaks

My basic recommendation for learning how line breaks work is to experiment and discover hit
<Enter> once (i.e., insert one newline), then hit it twice (i.e., insert two newlines), see what
happens. Youll soon learn to get what you want. Markdown Toggle is your friend.
Here are some things to try out:
Here 's a line for us to start with.

This line is separated from the one above by two newlines , so it will be a
* separate paragraph *.

This line is also a separate paragraph , but ...

This line is only separated by a single newline , so it 's a separate line in the
*same paragraph *.

Heres a line for us to start with.

This line is separated from the one above by two newlines, so it will be a separate paragraph.
This line is also begins a separate paragraph, but
This line is only separated by a single newline, so its a separate line in the same paragraph.
(Technical note: Markdown Here uses GFM line breaks, so theres no need to use MDs two-space
line breaks.)

Youtube videos

They cant be added directly but you can add an image with a link to the video like this:
<a
href =" http :// www. youtube .com/ watch? feature = player_embedded &v= YOUTUBE_VIDEO_ID_HERE
" target =" _blank "><img src =" http :// img. youtube .com/vi/ YOUTUBE_VIDEO_ID_HERE /0. jpg"
alt =" IMAGE ALT TEXT HERE" width ="240" height ="180" border ="10" /></a>

Or, in pure Markdown, but losing the image sizing and border:
[![ IMAGE ALT TEXT
HERE ]( http :// img. youtube .com/vi/ YOUTUBE_VIDEO_ID_HERE /0. jpg)]( http :// www. youtube .com/ watch ?v= YOU

Still confused? Email support@penip.com for help!

7 Sections and Folders

Folders can be created in the web editor to organize your book or writing project. Not only are
folders a handy way to split your project into manageable pieces for editing, theyre also used for
display.
Folders are represented as sections outside the editor. Penip Help, for example, has the following
sections: Getting Started, Writing, and Working Oine. Each of these sections is actually folder
containing numerous les.
When a project is downloaded as a PDF, folders become parts, and are included in the table of
contents with chapters nested beneath them.

Organizing folders

Within the Penip editor, folders can be dragged and dropped to reorder. Files can be dragged and
dropped between folders.

Hiding folders

If you do not want to include a folder in the compiled output (e.g. a notes folder), there is no shortcut
for currently doing so. Youll have to manually hide each le within the folder.

Renaming folders

Unsupported in the Penip editor at this time, coming soon!

Currently could be done oine by editing content of the le _title.md in the target folder.

Deleting folders

As a precaution, you can only delete empty folders. To delete a folder with contents, rst delete or
move the contents to another folder.

23
8 MathJax

Penip uses the MathJax javascript library to display mathematical notation. Notation is written in
LaTeX and wrapped in delimiters. Penip uses ... for inline math, and $$ $$ for display math.

Inline Math

Penip uses ... for inline math delimiters. Heres an example:

is rendered as:
Pythagorean equation: a2 + b2 = c2

Display Math

Penip uses $$ $$ for display math delimiters. Unlike inline equations, display equations must be
written on their own line. Display math delimiters can be included on the equation line, or on lines
preceding and following the equation line (spanning three lines). Heres an example:

is rendered as:

b b2 4ac
x=
2a

Resources
MathJax documentation
LaTeX mathematics documentation

24
9 Keyboard Shortcuts

Penip has a handful of keyboard shortcuts to help you write more eciently.
The following shortcuts are available while writing:

General
Save current le: Ctrl/ + S
New book le*: Ctrl/ + N
Toggle between edit and preview: Ctrl/ + R
Show keyboard shortcuts: Ctrl/ + K
Close dropdowns/popups: Esc

Selected text
Bold: Ctrl/ + B
Italics: Ctrl/ + I
Link: Ctrl/ + L
Heading (h2): Ctrl/ + H

* not available in Google Chrome

25
10 Code block syntax highlighting

For syntax highlighting, you can specify a language for a code block:
```haskell
qsort [] = []
```

The following languages are supported:

actionscript , ada , apache , asn1 , asp , awk , bash , bibtex , boo , c, changelog ,
clojure , cmake , coffee , coldfusion , commonlisp , cpp , cs , css , curry , d,
diff , djangotemplate , doxygen , doxygenlua , dtd , eiffel , email , erlang ,
fortran , fsharp , gnuassembler , go , haskell , haxe , html , ini , java , javadoc ,
javascript , json , jsp , julia , latex , lex , literatecurry , literatehaskell ,
lua , makefile , mandoc , markdown , matlab , maxima , metafont , mips , modelines ,
modula2 , modula3 , monobasic , nasm , noweb , objectivec , objectivecpp , ocaml ,
octave , pascal , perl , php , pike , postscript , prolog , python , r,
relaxngcompact , restructuredtext , rhtml , roff , ruby , rust , scala , scheme ,
sci , sed , sgml , sql , sqlmysql , sqlpostgresql , tcl , texinfo , verilog , vhdl ,
xml , xorg , xslt , xul , yacc , yaml

For example:
ls -1 | while read file; do new_file =$(echo $file | sed s/\ /_/g); mv "$file"
" $new_file "; done

26
11 YAML Front Matter

In an eort to make content cross-compatible for multiple purposes (e.g. a Jekyll blog and a PDF
ebook), Penip has support for basic YAML front matter. Basic is an understatement, really, since
the only attribute that is supported right now is title. Exactly like Jekyll, the front matter must be
the rst thing in the le and must take the form of valid YAML set between triple-dashed lines.
Your title front matter should look like this:
--- title: Learning CSS ---

This will be displayed as an H1 element (markdown #) in previews, downloads, etc.

27
 Part III

Publishing

28
12 Publishing Overview

Penip projects can be converted and downloaded with a single click, turning a collection of text
les into a beautiful compilation.
You can download any project you have access to, including both public and private projects, by
clicking Download from the project page.

Export formats

The following formats are currently supported: .pdf, .docx, .epub, html, and plain text. You can
also download the full source of a project, which includes all project les and folders unaltered.

Organizing contents

Files can be reordered by dragging and dropping in the editor sidebar, which represents how they will
be displayed on the project page as well as in downloads.
Working oine? See organizing contents oine.

Exclude les from publishing

Sometimes you may want to exclude a specic le from the published compilation - for example,
an unnished chapter, or maybe a notes le. To exclude a le, simply click the eye icon beside the
lename in the Penip editor. Hidden les can be edited, but will not be displayed outside the editor.

29
 30

Downloading alternate versions

By default, the master version of a project is compiled when downloading, but you can download
alternate and past versions. To do this, view any version or tag for a given project by selecting
accordingly from the project page, as seen in this screenshot:

Clicking Download while viewing a particular version or tag will compile and download the project
with the current selection. If you tag your releases (v1, v1.5, etc), you can download those past
releases at any point in time.
13 Publishing Options

There are a few default book styles (Technical, Business, and Fiction) to select from when a project is
created. These defaults set appropriate page sizes and font styles for project downloads. Document
projects have a single default style.
Customize the style and formatting of downloads in Settings > Publishing Options.
Here is a full list of publishing options:
Book options:
Table of contents, page breaks, page numbers
Cover style:
Cover page, cover color, title color, author color
Text options:
Font style, paragraph indent, font size, line spacing, link color
Page formatting:
Page width, page height, top margin, bottom margin, left margin, right margin
Code block styling:
Line numbers, border, border color, background color, keyword color, string color, comment color

Copyright Options

From your project settings page, you can choose between a traditional copyright (e.g. 2014 John
Doe) or a Creative Commons public copyright license. Penip uses the latest Creative Commons
Version 4.0 licenses. Several options let you customize the license to t your needs.
These licenses are primarily for inclusion in compiled PDFs, but you can also choose to display the
selected copyright on your project page.

31
14 Cover Images

PDF and ePub books (or documents) can have cover images. To set a cover image, upload a le
named cover.png or cover.jpg to your images folder. This image will be set as the books cover
image when published. If a cover image is not uploaded, a basic title page is used by default.

Dimensions

Cover image dimensions should match that of your book. A technical or business book cover image
should be 8.5 x 11 in, while a ction cover image should be 6 x 9 in. If you change the dimensions of
your book via project settings, be sure to upload an appropriately sized cover image. Its important
to have the correct proportions, as a misproportioned image will yield undesired white space on the
cover.

Resolution

For highest quality, a resolution of 300 pixels per inch (PPI) is recommended. Resolution can be set
when exporting a le in Photoshop or Illustrator.

8.5 x 11 at 300 PPI is 2550 x 3300 pixels

6 x 9 at 300 PPI is 1800 x 2700 pixels

Lower resolutions can be used (the image will be scaled to t), but may result in a blurry or pixelated
cover image.

32
 Part IV

Working Oine

33
15 Working with Git

Internally, Penip uses Git to manage versions, changes, and merges. By using Git or a Git-enabled
tool, you can sync writing projects on your computer with Penip. This allows you to work oine
(using any text editor you want), then push your changes to Penip with a single click.

Using command-line Git

If you are familiar with using Git from the command-line, you can have at it. The clone URL to use
is available from your projects Settings page.
If you want to work oine with command-line Git on a version of anothers project, here are some
pointers to make it work:

1. Get the clone link of the project. This is the link you see on top of the page of the project +
.git. For example with this project you do
git clone https://www.penflip.com/Penflip/help.git

2. Work locally

3. Push to your version branch, for example user loren would do

git push origin master:loren

Using the GitHub desktop app

Note: Ill be using the Mac app here, but the steps should be similar for the Windows app.
1) Download and install the GitHub desktop app
For Mac: http://mac.github.com/
For Windows: http://windows.github.com/
2) Create a project on Penip
If you dont have a project yet, create a project here: http://www.penflip.com/projects/new
3) Download your project
You can download your project and add it to the GitHub app at the same time.
For Mac, type this in your browser:

34
 35

github-mac://openRepo/PENFLIP-LINK-TO-YOUR-PROJECT
For Windows, type this in your browser:
github-windows://openRepo/PENFLIP-LINK-TO-YOUR-PROJECT
Make sure to include the full link to your Penip project. For example:
github-mac://openRepo/http://www.penflip.com/loren/how-to-work-offline
The GitHub app will open. Select where you want to download your project to, and click Clone.

You now have a copy of your project on your computer, including the full history of changes you
(and your collaborators) have made.
 36

4) Make changes
Your project is now on your computer like any other le or folder. You can make changes using and
text editor. Here, Im using textmate.

5) Sync changes with Penip

The following steps are done through the GitHub app.
Switch to the Changes tab:
 37

Turn on Commit & Sync (square toggle switch):

Type a description of your changes in the Commit summary box:

 38

Click Commit & Sync:

6) Done!
Verify that your changes have been synced with Penip by looking at your project page.
 39

Still confused? Email support@penip.com for help!

16 Organizing Contents

In the web editor, you can organize the contents of your book via a drag and drop interface. This
is obviously not available if youre working oine. Instead, youll notice a Contents.txt le (hidden
in the Penip web editor), which achieves the same goal: displaying and organizing the contents of
your book.
The Contents.txt le should contain a list of les to be included in your compiled book. The structure
is simple: list one lepath per line. You can add, remove, or rearrange lepaths as necessary. Only
the les listed in Contents.txt will be included in your project when it is exported.
An example Contents le:
About .md
introduction .md
part -1/ chapter1 .md
part -1/ chapter2 .md
part -2/ chapter3 .md
end.md

Filepaths are case-insensitive.

40
17 Generating SSH Keys

Note: this guide is primarily for OSX. There will be slight variations for other platforms.

Step 1: Check for SSH keys

First, check for existing ssh keys on your computer. Open up Terminal and run:
cd ~/. ssh
ls
# Lists the files in your .ssh directory

Check to see if you have a le named either id_rsa.pub or id_dsa.pub. If you dont have either of
those les go to step 2. Otherwise, you already have an existing keypair, so you can skip to step 3.

Step 2: Generate a new SSH key

To generate a new SSH key, enter the code below. When asked to enter a le in which to save the
key, just press enter for default settings.
ssh - keygen -t rsa -C " your_email@example .com"
# Creates a new ssh key , using the provided email as a label
# Generating public / private rsa key pair.
# Enter file in which to save the key (/ Users /you /. ssh/ id_rsa ): [Press enter]
ssh -add id_rsa

Now you need to enter a passphrase. You should see something like this:
# Your identification has been saved in /Users /you /. ssh/ id_rsa .
# Your public key has been saved in / Users/you /. ssh/ id_rsa .pub.
# The key fingerprint is:
# 01:0f:f4 :3b:ca :85: d6 :17: a1 :7d:f0 :68:9d:f0:a2:db your_email@example .com

Step 3: Add your SSH key to Penip

Run the following code to copy the key to your clipboard (choose one corresponding to your operating
system):

41
 42

# Mac:
pbcopy < ~/. ssh/ id_rsa .pub

# Windows :
clip < ~/. ssh/ id_rsa .pub

# Linux:
sudo apt -get install xclip
# Downloads and installs xclip .

xclip -sel clip < ~/. ssh/ id_rsa .pub

# Copies the contents of the id_rsa .pub file to your clipboard

Alternatively, using a text editor, you can open the ~/.ssh/id_rsa.pub le and copy the contents of
the le manually.
Note: its important to copy the key exactly without adding newlines or whitespace. The pbcopy
command makes it easy to perform this setup perfectly.

1. Go to your Account
2. Click Advanced in the top navigation
3. Click Add SSH key
4. Paste your key into the Key eld (title should be auto-generated)
5. Click Add key

Thats it!

Step 4: Test SSH

To make sure everything is working youll now SSH to Penip. Enter the following command:
ssh -T git@penflip .com

You may see an RSA key ngerprint warning. Dont worry, this is supposed to happen.
If everything worked, you now have SSH access to Penip! You can access your projects via the
command line. For SSH access URLs, see Project Settings > Advanced from any of your projects.
 Part V

Project Management

43
18 Project Labels

Labels are a great way to sort and organize your projects. From your projects page, hover over a
project for the + label option. Once youve labeled your projects, click a label to show only projects
with the selected label. You can toggle labels on and o with the toolbar, and manage labels from
your account settings.

Projects can have multiple labels

You can only manage labels for projects you own (not projects youve joined)
Labels are not displayed on public projects in the Discover section

44