You can easily group related notes into a book, like this tutorial book.
Grouping notes into a book makes sharing and managing knowledge much easier.
Notes within a book can be further grouped into different sections, like "chapters" in a book. This gives readers context of your book .
Like all our features, making a book can be easily done with Markdown syntax.
Steps:
1. Create a new note, this note would become your book when you're done.
2. Create the title for your book , like how you create title for any note.
- Type the title at the top of your note
- Add 3 equals
===
right below it
Image Not Showing
Possible Reasons
- The image was uploaded to a note which you don't have access to
- The note which the image was originally uploaded to has been deleted
Learn More →
3. (optional) Create Section Title(s):
- Type section title(s) in your note, below the book title.
- Right below your section title(s), add 3 dashes
---
Image Not Showing
Possible Reasons
- The image was uploaded to a note which you don't have access to
- The note which the image was originally uploaded to has been deleted
Learn More →
4. Add links to notes you want in the book .
- Type 1 dash
-
followed by 1 space
to make an unordered list (or bullet points).
- Right after the space, create a link to your note, using Link Exploder.
Image Not Showing
Possible Reasons
- The image was uploaded to a note which you don't have access to
- The note which the image was originally uploaded to has been deleted
Learn More →
5. Repeat Step 3 and Step 4 until you are happy with your book .
Image Not Showing
Possible Reasons
- The image was uploaded to a note which you don't have access to
- The note which the image was originally uploaded to has been deleted
Learn More →
6. Publish!
Click the top right Sharing button, choose view mode as Book mode. You can preview the published page by clicking the Preview button to the right.
Image Not Showing
Possible Reasons
- The image was uploaded to a note which you don't have access to
- The note which the image was originally uploaded to has been deleted
Learn More →
7. Share!
- Now your note has been set as Book mode, you can share it! Remember to give proper permission for the note, then other people can access it.
- Your very first note would be the landing page of the book, and it would appended at the end of the URL.
- You can ignore the appended url for simplicity, or change your landing page as you pleased by changing the appended URL part.
Image Not Showing
Possible Reasons
- The image was uploaded to a note which you don't have access to
- The note which the image was originally uploaded to has been deleted
Learn More →
Frequently Neglected Points:
- All links to notes should have a dash and space
-
in front of it (so it would look like it's listed in an unordered list in your View pane).
Pro tip
1. External Link
You could also add [target=_blank]
to force the link open in new tab, like this:
- [Release Notes](/s/release-notes) [target=_blank]
If you add a link starts with http (non-SSL), we'll also make it open in new tab.
2. Quickly bring readers back to the catalog with the embed feature
You can combine the Embedded Notes feature to allow readers to quickly return to a page with a book catalog.
Paste a link to one of the notes from Book Mode into the embedded note.
Now, try making the following text into an embeddable note.
Go back to the first page of the instruction manual: https://hackmd.io/c/tutorials/%2Fs%2Ftutorials
Image Not Showing
Possible Reasons
- The image file may be corrupted
- The server hosting the image is unavailable
- The image path is incorrect
- The image format is not supported
Learn More →
Click me!
This saves you from having to re-paste the text and lets the reader know where to go back in the book with the catalog.