LogoLogo
Packmind CloudChangelogGet supportJoin Slack
  • 👋Welcome!
  • 🪐Manage spaces
  • 🔐Security and data
  • 🐞Troubleshooting guides
  • 🚀First steps
    • Enable and configure AI
    • Connect your Git platform
  • 📥Capture your coding practices
    • How to create coding practices
    • Review practices in the Inbox
  • 🔍Enforce practices in your code
    • Setup practices detection with the AI Agent
    • Packmind CLI
      • Run with NPM
      • Run with Docker
      • SonarQube Integration
      • Run in Gitlab CI
      • Usage
  • Coding Assistants Integration
  • 👩‍💻Plugins & Integrations
    • IDE Plugins
      • 🚀Packmind's IDE plugins use cases
      • Visual Studio Code
      • Visual Studio
      • JetBrains IDEs
      • Eclipse
      • Xcode
      • Packmind Tech Coach
    • 🔔Get notifications
  • 📖Best practices management
    • Manage your practices
      • Import, copy and export practices
      • Use categories to organize your practices
      • Manage duplications of practices
      • Move all practices from a space to another space
      • Styling with Markdown
      • Multi-file examples on coding practices
    • 📰Scheduler to push practices
  • ↔️API Reference
    • Authentication
    • Documentation
  • ⚙️Account & Settings
    • 👩‍💼Manage users
    • 💵Subscription and Billing
    • 🔓Single Sign-On (SSO) in Packmind
      • Enable SSO for Packmind Cloud
      • Enable SSO for Packmind Self-Hosted
  • 🏠On-Premise version
    • Release notes - Self-Hosted versions
    • Install the Self-Hosted version
      • Migrate from a legacy setup (Mongo 2.x)
    • Connect a SMTP server
    • Authentication
      • Authentication with OpenLDAP
      • Authentication by SSO
      • Authentication with Active Directory
Powered by GitBook
On this page

Was this helpful?

  1. Best practices management
  2. Manage your practices

Styling with Markdown

How to use Markdown with Packmind

PreviousMove all practices from a space to another spaceNextMulti-file examples on coding practices

Last updated 3 months ago

Was this helpful?

Practices descriptions support standard flavored . You can use it to format text, put some emphasis, image, links, code snippets and much more.

Editors will have an eye button on the top right corner to toggle the preview.

Quick overview of commonly used elements

Here you will find a cheat sheet of commonly used Markdown. Everything is standard with some extras to .

Bold

some **bold text**

Italic

some *italic text*

Strikethrough

 some ~~Striked words~~

Title / header

# Big Header
### Small Header

Blockquote

> some quote
> on two lines

Highlight

some `highlighted words`

Lists

1. Ordered
2. List
3. Items

- Unordered
- List
- Items

Link

[link text](target-url)

Image

![image alt](image-source)

Image must be from https source and it will be blocked if not. Also, it is possible to format the image using the following alts.

Example: ![q2 center](https://my.img.src) -> Make the image 50% of the view and center it.

Alt
Effect

xsmall

width: 50px

small

width: 100px

medium

width: 200px

large

width: 400px

xlarge

width: 800px

width25

width: 25%

width50

width: 50%

width75

width: 75%

width100

width: 100%

center

Center the image

right

Image float right

left

Image float left

Code snippets

Snippets support syntax highlighting. Replace "typescript" on the first line by your language name.

```typescript
// some typescript code
const someCode: string = "Hello World";
```
📖
Markdown
images