Skip to content

Instantly share code, notes, and snippets.

@ArghyaChatterjee
Last active December 13, 2024 19:01
Show Gist options
  • Save ArghyaChatterjee/e470eb838b88139a423b523eb0e3d528 to your computer and use it in GitHub Desktop.
Save ArghyaChatterjee/e470eb838b88139a423b523eb0e3d528 to your computer and use it in GitHub Desktop.

Preview github readme in VS code

To preview a README file (typically in Markdown format) in the VS Code editor, follow these steps:

Activate the Markdown Preview

  • Option 1: Use the Command Palette
    • Press Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (Mac) to open the Command Palette.
    • Type Markdown: Open Preview and select it.
  • Option 2: Use the Keyboard Shortcut
    • Press Ctrl+Shift+V (Windows/Linux) or Cmd+Shift+V (Mac) while the README.md file is open.
  • Option 3: Use the Toolbar
    • Click the Open Preview to the Side button in the top-right corner of the editor (it looks like a split square icon).
  • Option 4: Right-Click
    • Right-click in the editor and select Open Preview.

Preview Side-by-Side

  • If you want to see the raw Markdown and the rendered preview side by side:
    • Use the Command Palette or click the Split Editor button at the top-right of the editor.
    • Drag the Markdown preview pane next to the raw Markdown text.

Install Markdown Extensions (Optional)

These extensions provide additional features like table of contents, export options, and custom styles.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment