owned this note   changed a year ago  
Linked with GitHub

中文教學

How to Publish a Note with Permalink

You can publish your notes with permalinks and in custom view modes to your profile page.

Learn more about profile page

You can now set the permalink for a note in the Sharing menu.
Your permalink follows this pattern:

https://hackmd.io/@<username>/<custom_permalink>

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 →
Hint: Remember to change your username in
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 →
settings.

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 →

Permalinks can contain non-English characters, you can even use emojis.

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 →

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 →
Hint: You can click on your profile picture in the top right corner, then set your desired username in the Settings menu!

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 →
Note

The URLs for automatically generated notes will automatically redirect, so the random URLs you shared previously can still be used. When users access HackMD, they will see the latest permalink you have set.

However, HackMD only records the latest set permalink for each note. Therefore, if you change the permalink or your username again, it will invalidate the previously shared permalinks!

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 →

 

View Modes

You can also choose the default view mode in which the note would be accessed. For example, if you choose Slide mode, when people access the note it would automatically be shown in the slide mode.

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 →

The default view mode chosen can be overwritten with URL switch (parameters) following the permalink.

View Modes Explained

Mode Note shows in URL switch
Edit mode Your favorite real-time collaborative editor. /edit
View mode A clean, static page where view count adds up. ?type=view
Book mode A "book" of links. Learn more about book mode. ?type=book
Slide mode A slide deck. Learn how to create a slide. ?type=slide

Publishing a Note

Publish the note by clicking the Publish button at the bottom of the Sharing menu.
Published notes can be indexed by search engines, and everyone on the web would be able to find and read them.

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 →
Hint: This only applies to newly published notes. If you had "published" old notes with the old icon, the search engine behavior described above will not happen.

Published notes would have their Read permissions set to world-readable.

Publish a note

You can always unpublished a note by clicking on the same button - no one can access this note anymore, except your invited collaborators.

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 →
Note： The internet remembers, so hit the big blue button with care.

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 →
Hint: You can always set a permalink for each note for easier sharing, whether it is published or not.

Select a repo