Documentation
ドキュメント

Member listメンバー一覧 Register登録・サインイン

Documentation: Markdown

Markdown basics
  • Markdown is a simple code system that allows you to write in plaintext and have it appear with formatting. vkgy uses a modified form of Markdown with additional functionality.
  • For an explanation of both basic and advanced Markdown, as well as vkgy's custom Markdown features, see this blog post.
Advanced: how mentioning works
  • Most users don't have to worry about this, but if you're curious, this is how linking works.:
  • When you type / and select an artist, a formatted token with that artist's name will be shown in the textarea. However, the raw text that's actually added will look like this: (123)/band name/[optional display name].
  • The (123) portion is the artist's ID. This is what's used by the database to generate the link. The /band name/ portion is purely decorative; it is only there so the person writing/editing the text will know which artist is being referenced. The [optional display name] may or may not be present; it allows you to manually override the artist's official name with some other text (e.g. their old name).
  • In rare cases (such as within a musician's band history), you may encounter plain text like (123); this just means that someone manually entered the band's ID instead of using the handy dropdown (probably long ago, before such functionality existed).
  • As a shortcut, you can manually type out /band name/ and ignore the dropdown. The system will then attempt to link to the appropriate profile. However, this can have unintended consequences when multiple bands share the same name—always double check that the correct artist has been linked.
  • A similar pattern is followed by labels: {123}=label name=[optional display name].
  • If you ever encounter an issue where an artist or label mention seems wrong, it is most likely due to them having a symbol like /, @, or = in their name. Below the textarea, click on Plain Editor to switch to the raw text view; there, you can remove the offending symbol to fix the issue.
top