# CodiMD Documentation - [CodiMD Documentation](/s/codimd-documentation) - [CodiMD Release Notes](/@codimd/release-notes) - [GitHub Repository](https://github.com/hackmdio/codimd) [target=_blank] - [@CodiMD_Dev on Twitter](https://twitter.com/CodiMD_Dev) [target=_blank] # User Guides - ## Note Editor - [Understanding Your Editor](/@codimd/understanding-your-editor) - [Manage Note Permission](/@codimd/note-permission) - ## Note Writing - [Markdown Syntax Reference](/@codimd/markdown-syntax) - [Extra Supported Syntax](/@codimd/extra-supported-syntax) - [Fretboard Syntax Guide](/@docs/fretboard-syntax) # Administration Guides - ## Deployment - [Docker Deployment](/s/codimd-docker-deployment) - [Kubernetes Deployments](/@codimd/k8s-deployment) - [Heroku One Click Deployment](/s/codimd-heroku-deployment) - [Scalingo One Click Deployment](/@codimd/scalingo-deployment) - ## Setup HTTPS - [Overview](/@codimd/ByDxZQgBL) - ### Example - [Using Apache](/@codimd/web-server-apache) - [Using nginx](/@codimd/web-server-nginx) - [Using HAProxy](/@codimd/web-server-haproxy) - ## Configuration - [CodiMD Configuration Overview](/s/codimd-configuration) - ### Authentication Guides - #### Single Sign-On - [SAML](/s/codimd-auth-saml) - [SAML - OneLogin as example](/s/codimd-auth-saml-onelogin) - [Active Directory (LDAP)](/s/codimd-auth-active-directory) - #### OAuth - [OAuth - Bitbucket](/@codimd/oauth-bitbucket) - [OAuth - Dropbox](/@codimd/oauth-dropbox) - [OAuth - Facebook - WIP](/@codimd/oauth-facebook) - [OAuth - GitHub](/s/codimd-oauth-github) - [OAuth - GitLab](/s/codimd-oauth-gitlab) - [OAuth - Google - WIP](/@codimd/oauth-google) - [OAuth - Mattermost](/s/codimd-oauth-mattermost) - [OAuth - OpenID - WIP](/@codimd/oauth-openid) - [OAuth - Twitter](/s/codimd-oauth-twitter) - [Generic OAuth 2.0](/@codimd/codimd-generic-oauth-2) - [OAuth - Nextcloud](/s/codimd-oauth-nextcloud) - [OAuth - Diccord](/k9TDMWBmTW69x3gd15zTQg) - [OAuth - Callback URLs](/s/codimd-oauth-callback-urls) - ### Image Storage - [Store Image on S3](/s/codimd-image-storage-S3) - [Store Image on Minio](/s/codimd-image-storage-minio) - ### Other Customization - [Customize Pre-load Terms of Use or Privacy Policy](/s/codimd-preload-notes) - ## Upgrading and Migration - [Upgrading CodiMD](/s/codimd-upgrade) - [Etherpad-lite Migration Guide](/s/codimd-migration-etherpad) - ### [CodiMD Migrations and Version Changes](/s/codimd-migration-and-changes) - [Migrate from 1.4.1 to 2.0.0](/@codimd/migrate-2-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](/s/codimd-manual-deployment) - [Database Connection Guide](/s/codimd-db-connection) - [Project Structure](/s/codimd-project-structure) - [Webpack](/s/codimd-webpack) --- ###### tags: `CodiMD` `Docs` `book`