CodiMD Documentation

• CodiMD Documentation
• CodiMD Release Notes
• GitHub Repository
• @CodiMD_Dev on Twitter

User Guides

• Note Editor

  • Understanding Your Editor
  • Manage Note Permission

• Note Writing

  • Markdown Syntax Reference
  • Extra Supported Syntax
    • Fretboard Syntax Guide

Administration Guides

• Deployment

  • Docker Deployment
  • Kubernetes Deployments
  • Heroku One Click Deployment
  • Scalingo One Click Deployment

• Setup HTTPS

  • Overview

  • Example

    • Using Apache
    • Using nginx
    • Using HAProxy

• Configuration

  • CodiMD Configuration Overview

  • Authentication Guides

    • Single Sign-On

      • SAML
      • SAML - OneLogin as example
      • Active Directory (LDAP)

    • OAuth

      • OAuth - Bitbucket
      • OAuth - Dropbox
      • OAuth - Facebook - WIP
      • OAuth - GitHub
      • OAuth - GitLab
      • OAuth - Google - WIP
      • OAuth - Mattermost
      • OAuth - OpenID - WIP
      • OAuth - Twitter
      • Generic OAuth 2.0
        • OAuth - Nextcloud
        • OAuth - Diccord
      • OAuth - Callback URLs

  • Image Storage

    • Store Image on S3
    • Store Image on Minio

  • Other Customization

    • Customize Pre-load Terms of Use or Privacy Policy

• Upgrading and Migration

• Upgrading CodiMD
• Etherpad-lite Migration Guide

• CodiMD Migrations and Version Changes

  • Migrate from 1.4.1 to 2.0.0

Join our contributor community! Start from deploying CodiMD manually, connecting to your own database, learn about the project structure, to build your changes with the help of webpack.

Developer Guides

• CodiMD Manual Deployment
• Database Connection Guide
• Project Structure
• Webpack

---

tags: CodiMD Docs book