Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
research-topics-mat-tuhh research-topics-mat-tuhh
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 10
    • Issues 10
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Merge requests 4
    • Merge requests 4
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Operations
    • Operations
    • Incidents
    • Environments
  • Packages & Registries
    • Packages & Registries
    • Container Registry
  • Analytics
    • Analytics
    • CI/CD
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Members
    • Members
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • Fabian Nuraddin Alexander Gabel
  • research-topics-mat-tuhhresearch-topics-mat-tuhh
  • Wiki
  • Editing Markdown

Last edited by Fabian Nuraddin Alexander Gabel Sep 03, 2021
Page history

Editing Markdown

Check out this short Markdown Guide.

Templates

Check out the styleguide. You will find different examples with comments there. Alternatively browse the topics that have already been integrated here.

Markdown Editors

Depending on how you want to work on your mardown files there are different options. Online options are straightforward to use, offline options provide more features:

  • Hedgedoc
  • VSCodium

Online: HedgeDoc

Just login at https://writemd.rz.tuhh.de/ and create a new note. Paste all of the above into a document and work on it. If the TUHH instance of HedgeDoc is not available, you get the same service at Just visit https://demo.hedgedoc.org/ .

image

Offline: VSCodium (MIT license) / VSCode (Microsoft)

Download VSCodium and install the Mathpix Markdown extension.

Render your document with <CTRL>+<SHIFT>+V

image

Alternatively, go to VSCode and install the Markdown+Math extension. VSCode works the same as VSCodium but with Microsoft's branding. See here.

As for VSCodium, render your document with <CTRL>+<SHIFT>+V

See here for learning how to install extensions from the marketplace.

Clone repository
  • Continuous Integration and Continuous Deployment
  • Dependencies
  • Editing Markdown
  • Getting Started
  • Integrations
  • Maintenance
  • Postprocessing
  • Preprocessors
  • Program Flow
  • Repository Structure
  • Styleguide
  • Testing
  • Workflow
  • Home