{"id":4764,"date":"2026-07-08T14:42:20","date_gmt":"2026-07-08T05:42:20","guid":{"rendered":"https:\/\/bdsl.jbnu.ac.kr\/blog\/?p=4764"},"modified":"2026-08-03T18:15:33","modified_gmt":"2026-08-03T09:15:33","slug":"documentation-with-markdown","status":"publish","type":"post","link":"https:\/\/bdsl.jbnu.ac.kr\/blog\/documentation-with-markdown\/","title":{"rendered":"Introduction to Markdown for BDSL Laboratory"},"content":{"rendered":"\n<p class=\"wp-block-paragraph\">(*) This document was generated by ChatGPT based on an outline prepared for the &#8220;Markdown for BDSL Laboratory&#8221; guide.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Introduction<\/strong><\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">Markdown is a lightweight markup language for creating structured documents using plain text. Instead of focusing on the visual appearance of a document, Markdown describes its logical structure through a simple and intuitive syntax. Common document elements\u2014including headings, paragraphs, lists, tables, hyperlinks, images, mathematical equations, and source code\u2014can be written using only a small set of plain-text symbols. As a result, Markdown documents remain readable even without dedicated software and can be edited using virtually any text editor.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Compared with conventional word processors, Markdown provides several important advantages for scientific research. Since Markdown files are plain text, they are lightweight, platform-independent, and compatible with version control systems such as Git. They can also be converted into many other formats, including HTML, PDF, Microsoft Word, and presentation slides. These characteristics make Markdown particularly suitable for collaborative research, software development, and reproducible scientific documentation.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">In the <strong>Bioinformatics and Data Science Laboratory (BDSL)<\/strong>, Markdown is the standard format for documenting research activities. Project documentation, laboratory protocols, analysis reports, meeting minutes, software documentation, GitLab Wiki pages, and README files are all primarily written in Markdown. Using a common documentation format improves consistency among projects, facilitates collaboration between laboratory members, and enables efficient tracking of document revisions through Git.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">The appearance of a Markdown document depends on the application used to render it. Although the core syntax is standardized, different platforms may support additional features or display documents differently. Throughout this guide, we focus on the syntax and conventions adopted in the BDSL. Unless otherwise noted, all examples are based on <strong>GitLab Flavored Markdown (GLFM)<\/strong>, which is the primary Markdown implementation used in our laboratory.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">One important exception is the <strong>BDSL homepage<\/strong>, which is built using WordPress. WordPress employs its own block-based editor rather than GitLab Flavored Markdown. Nevertheless, most standard Markdown syntax is compatible with WordPress, and Markdown documents can usually be copied into WordPress with only minor modifications.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">This guide introduces the fundamental components of Markdown and demonstrates how they are used in laboratory documentation. The objective is not to describe every available Markdown feature, but rather to provide the practical knowledge necessary for creating clear, consistent, and maintainable documents within the BDSL.<\/p>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity is-style-wide\"\/>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Components of Markdown<\/strong><\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">Markdown consists of a small number of document elements that can be combined to create rich and well-organized documents. The following chapters introduce each component in detail.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>Document Structure<\/strong><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">A Markdown document is organized hierarchically using headings and paragraphs. Good document structure improves readability and allows automatic generation of a table of contents.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Topics include:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li> Markdown files<\/li>\n\n\n\n<li>File organization<\/li>\n\n\n\n<li> Heading hierarchy<\/li>\n\n\n\n<li> Logical document organization<\/li>\n<\/ul>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity is-style-wide\"\/>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>Headings<\/strong><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Headings define the hierarchical structure of a document.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Topics include:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Heading levels (`#`\u2013`######`)<\/li>\n\n\n\n<li>Section organization<\/li>\n\n\n\n<li> Best practices for heading hierarchy<\/li>\n<\/ul>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity is-style-wide\"\/>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>Paragraphs<\/strong><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Paragraphs are the fundamental building blocks of text.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Topics include:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Paragraph separation<\/li>\n\n\n\n<li>Line breaks<\/li>\n\n\n\n<li>Horizontal rules<\/li>\n<\/ul>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity is-style-wide\"\/>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>Text Formatting<\/strong><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Markdown supports several methods for emphasizing text while maintaining readability.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Topics include:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>**Bold text**<\/strong><\/li>\n\n\n\n<li><em>*Italic text*<\/em><\/li>\n\n\n\n<li><strong>**<\/strong><em>*Bold italic*<\/em><strong>**<\/strong><\/li>\n\n\n\n<li><s>~~Strikethrough~~<\/s><\/li>\n\n\n\n<li>Superscripts and subscripts (when supported)<\/li>\n<\/ul>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity is-style-wide\"\/>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>Inline Code<\/strong><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Inline code highlights commands, filenames, variables, or short code fragments.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Typical applications include:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Terminal commands<\/li>\n\n\n\n<li>File paths<\/li>\n\n\n\n<li>Program names<\/li>\n\n\n\n<li>Configuration options<\/li>\n\n\n\n<li>Function names<\/li>\n<\/ul>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity is-style-wide\"\/>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>Blockquotes<\/strong><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Blockquotes are useful for displaying quotations, notes, warnings, or important remarks.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Typical applications include:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Important notes<\/li>\n\n\n\n<li>Warnings<\/li>\n\n\n\n<li>Tips<\/li>\n\n\n\n<li>Literature quotations<\/li>\n<\/ul>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity is-style-wide\"\/>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>Lists<\/strong><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Markdown supports several types of lists for organizing information.<\/p>\n\n\n\n<h4 class=\"wp-block-heading\"><strong>Unordered Lists<\/strong><\/h4>\n\n\n\n<p class=\"wp-block-paragraph\">Useful for<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Bullet points<\/li>\n\n\n\n<li>Feature lists<\/li>\n\n\n\n<li> Summaries<\/li>\n<\/ul>\n\n\n\n<h4 class=\"wp-block-heading\"><strong>Ordered Lists<\/strong><\/h4>\n\n\n\n<p class=\"wp-block-paragraph\">Useful for<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Procedures<\/li>\n\n\n\n<li>Experimental protocols<\/li>\n\n\n\n<li>Step-by-step instructions<\/li>\n<\/ul>\n\n\n\n<h4 class=\"wp-block-heading\"><strong>Nested Lists<\/strong><\/h4>\n\n\n\n<p class=\"wp-block-paragraph\">Useful for organizing complex information into multiple levels.<\/p>\n\n\n\n<h4 class=\"wp-block-heading\"><strong>Task Lists<\/strong><\/h4>\n\n\n\n<p class=\"wp-block-paragraph\">GitLab supports interactive task lists.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Example applications include:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Project management<\/li>\n\n\n\n<li>TODO lists<\/li>\n\n\n\n<li>Manuscript revision tracking<\/li>\n\n\n\n<li>Experimental checklists<\/li>\n<\/ul>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity is-style-wide\"\/>\n\n\n\n<p class=\"wp-block-paragraph\"><\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Scientific Documentation<\/strong><\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">Markdown is particularly useful for scientific writing because it integrates text, figures, mathematics, and source code within a single document.<\/p>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity is-style-wide\"\/>\n\n\n\n<p class=\"wp-block-paragraph\"><\/p>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>Tables<\/strong><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Tables organize structured information in a compact format.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Typical uses include:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Experimental metadata<\/li>\n\n\n\n<li>Statistical summaries<\/li>\n\n\n\n<li>Sample information<\/li>\n\n\n\n<li>Software versions<\/li>\n<\/ul>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity is-style-wide\"\/>\n\n\n\n<p class=\"wp-block-paragraph\"><\/p>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>Images<\/strong><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Images can be inserted directly into Markdown documents.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Topics include:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Figure insertion<\/li>\n\n\n\n<li>Relative image paths<\/li>\n\n\n\n<li>Image organization<\/li>\n\n\n\n<li>Figure captions<\/li>\n<\/ul>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity is-style-wide\"\/>\n\n\n\n<p class=\"wp-block-paragraph\"> <\/p>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>Code Blocks<\/strong><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Large code fragments should be placed inside fenced code blocks.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">GitLab automatically performs syntax highlighting for many programming languages, including:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Python<\/li>\n\n\n\n<li>R<\/li>\n\n\n\n<li>Bash<\/li>\n\n\n\n<li>YAML<\/li>\n\n\n\n<li>JSON<\/li>\n\n\n\n<li>C\/C++<\/li>\n\n\n\n<li><\/li>\n\n\n\n<li>JavaScript<\/li>\n<\/ul>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity is-style-wide\"\/>\n\n\n\n<p class=\"wp-block-paragraph\"> <\/p>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>Mathematical Equations<\/strong><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">GitLab supports LaTeX-style mathematical notation.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Applications include:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Mathematical formulas<\/li>\n\n\n\n<li>Statistical equations<\/li>\n\n\n\n<li>Matrix notation<\/li>\n\n\n\n<li>Chemical equations<\/li>\n\n\n\n<li>Scientific symbols<\/li>\n<\/ul>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity is-style-wide\"\/>\n\n\n\n<p class=\"wp-block-paragraph\"> <\/p>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>Mermaid Diagrams<\/strong><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">GitLab supports Mermaid, allowing diagrams to be generated directly from text.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Common diagram types include:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Flowcharts<\/li>\n\n\n\n<li>Sequence diagrams<\/li>\n\n\n\n<li>State diagrams<\/li>\n\n\n\n<li>Class diagrams<\/li>\n\n\n\n<li>Entity relationship diagrams<\/li>\n\n\n\n<li>Git graphs<\/li>\n\n\n\n<li>Timeline diagrams<\/li>\n\n\n\n<li>Mind maps<\/li>\n\n\n\n<li>Directory trees<\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">Because diagrams are defined using text, they can be version controlled alongside the rest of the document.<\/p>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity is-style-wide\"\/>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>References and Links<\/strong><\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">Markdown provides several mechanisms for connecting documents and citing external resources.<\/p>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity is-style-wide\"\/>\n\n\n\n<p class=\"wp-block-paragraph\"><\/p>\n\n\n\n<h3 class=\"wp-block-heading\"><strong> Hyperlinks<\/strong><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Links may refer to<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Websites<\/li>\n\n\n\n<li>GitLab pages<\/li>\n\n\n\n<li>Documents<\/li>\n\n\n\n<li>Images<\/li>\n\n\n\n<li>Downloads<\/li>\n\n\n\n<li>Email addresses<\/li>\n<\/ul>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity is-style-wide\"\/>\n\n\n\n<p class=\"wp-block-paragraph\"> <\/p>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>Footnotes<\/strong><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Footnotes provide supplementary explanations without interrupting the main text.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Typical uses include:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Additional explanations<\/li>\n\n\n\n<li>Definitions<\/li>\n\n\n\n<li>References<\/li>\n<\/ul>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity is-style-wide\"\/>\n\n\n\n<p class=\"wp-block-paragraph\"><\/p>\n\n\n\n<h3 class=\"wp-block-heading\"><strong> Cross References<\/strong><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Large documentation projects often consist of many Markdown files.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Cross references allow navigation between<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Sections<\/li>\n\n\n\n<li>Documents<\/li>\n\n\n\n<li>Figures<\/li>\n\n\n\n<li>Tables<\/li>\n\n\n\n<li>External repositories<\/li>\n<\/ul>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity is-style-wide\"\/>\n\n\n\n<p class=\"wp-block-paragraph\"> <\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong> Collaboration<\/strong><\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">One of the greatest advantages of Markdown is its integration with Git and collaborative development platforms such as GitLab.<\/p>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity is-style-wide\"\/>\n\n\n\n<p class=\"wp-block-paragraph\"><\/p>\n\n\n\n<h3 class=\"wp-block-heading\"><strong> Version Control<\/strong><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Markdown documents are plain text, allowing Git to record every modification.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Benefits include:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Complete revision history<\/li>\n\n\n\n<li>Comparison between versions<\/li>\n\n\n\n<li>Recovery of previous versions<\/li>\n\n\n\n<li>Collaborative editing<\/li>\n<\/ul>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity is-style-wide\"\/>\n\n\n\n<p class=\"wp-block-paragraph\"> <\/p>\n\n\n\n<h3 class=\"wp-block-heading\"><strong> Comments and Discussions<\/strong><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">GitLab enables collaborative review through inline discussions.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Laboratory members can<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Review documents<\/li>\n\n\n\n<li>Leave comments<\/li>\n\n\n\n<li>Suggest modifications<\/li>\n\n\n\n<li>Resolve discussions<\/li>\n\n\n\n<li>Track review progress<\/li>\n<\/ul>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity is-style-wide\"\/>\n\n\n\n<p class=\"wp-block-paragraph\"> <\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong> Best Practices in the BDSL<\/strong><\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">To maintain consistency across projects, the following practices are recommended.<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Use descriptive headings to organize documents.<\/li>\n\n\n\n<li>Keep paragraphs concise and focused on a single topic.<\/li>\n\n\n\n<li>Prefer relative links over absolute links within repositories.<\/li>\n\n\n\n<li>Store figures in dedicated directories such as `figures\/` or `images\/`.<\/li>\n\n\n\n<li>Use fenced code blocks for all source code.<\/li>\n\n\n\n<li>Write mathematical expressions using LaTeX notation.<\/li>\n\n\n\n<li>Organize documents according to the logical structure of the project.<\/li>\n\n\n\n<li>Commit documentation changes regularly to Git.<\/li>\n\n\n\n<li>Review Markdown rendering in GitLab before committing major revisions.<\/li>\n\n\n\n<li>Maintain consistent formatting throughout the repository.<\/li>\n<\/ul>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity is-style-wide\"\/>\n\n\n\n<p class=\"wp-block-paragraph\"> <\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong> Summary<\/strong><\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">Markdown is the standard documentation language used throughout the BDSL. Its simplicity, readability, and compatibility with Git make it an ideal format for research documentation, collaborative writing, and software development. By mastering a relatively small set of Markdown features, laboratory members can produce professional, maintainable, and reproducible documentation for projects of any size.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">The following chapters describe each Markdown component in detail and provide practical examples using GitLab Flavored Markdown.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>(*) This document was generated by ChatGPT based on an outline prepared for the &#8220;Markdown for BDSL Laboratory&#8221; guide. Introduction Markdown is a lightweight markup language for creating structured documents using plain text. Instead of focusing on the visual appearance of a document, Markdown describes its logical structure through a simple and intuitive syntax. Common [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_uag_custom_page_level_css":"","site-sidebar-layout":"default","site-content-layout":"","ast-site-content-layout":"default","site-content-style":"default","site-sidebar-style":"default","ast-global-header-display":"","ast-banner-title-visibility":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","ast-disable-related-posts":"","theme-transparent-header-meta":"","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","astra-migrate-meta-layouts":"set","ast-page-background-enabled":"default","ast-page-background-meta":{"desktop":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"ast-content-background-meta":{"desktop":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"footnotes":"","_members_access_role":[],"_members_access_error":""},"categories":[1],"tags":[],"class_list":["post-4764","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v28.4 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>Introduction to Markdown for BDSL Laboratory - Biomedical Data Science Laboratory<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/bdsl.jbnu.ac.kr\/blog\/documentation-with-markdown\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Introduction to Markdown for BDSL Laboratory - Biomedical Data Science Laboratory\" \/>\n<meta property=\"og:description\" content=\"(*) This document was generated by ChatGPT based on an outline prepared for the &#8220;Markdown for BDSL Laboratory&#8221; guide. Introduction Markdown is a lightweight markup language for creating structured documents using plain text. Instead of focusing on the visual appearance of a document, Markdown describes its logical structure through a simple and intuitive syntax. Common [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/bdsl.jbnu.ac.kr\/blog\/documentation-with-markdown\/\" \/>\n<meta property=\"og:site_name\" content=\"Biomedical Data Science Laboratory\" \/>\n<meta property=\"article:published_time\" content=\"2026-07-08T05:42:20+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2026-08-03T09:15:33+00:00\" \/>\n<meta name=\"author\" content=\"sphong\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"sphong\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"6 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/bdsl.jbnu.ac.kr\\\/blog\\\/documentation-with-markdown\\\/#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/bdsl.jbnu.ac.kr\\\/blog\\\/documentation-with-markdown\\\/\"},\"author\":{\"name\":\"sphong\",\"@id\":\"https:\\\/\\\/bdsl.jbnu.ac.kr\\\/blog\\\/#\\\/schema\\\/person\\\/8d22f775fcc218b1184ec0d890034e9b\"},\"headline\":\"Introduction to Markdown for BDSL Laboratory\",\"datePublished\":\"2026-07-08T05:42:20+00:00\",\"dateModified\":\"2026-08-03T09:15:33+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/bdsl.jbnu.ac.kr\\\/blog\\\/documentation-with-markdown\\\/\"},\"wordCount\":1084,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\\\/\\\/bdsl.jbnu.ac.kr\\\/blog\\\/#organization\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\\\/\\\/bdsl.jbnu.ac.kr\\\/blog\\\/documentation-with-markdown\\\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/bdsl.jbnu.ac.kr\\\/blog\\\/documentation-with-markdown\\\/\",\"url\":\"https:\\\/\\\/bdsl.jbnu.ac.kr\\\/blog\\\/documentation-with-markdown\\\/\",\"name\":\"Introduction to Markdown for BDSL Laboratory - Biomedical Data Science Laboratory\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/bdsl.jbnu.ac.kr\\\/blog\\\/#website\"},\"datePublished\":\"2026-07-08T05:42:20+00:00\",\"dateModified\":\"2026-08-03T09:15:33+00:00\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/bdsl.jbnu.ac.kr\\\/blog\\\/documentation-with-markdown\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/bdsl.jbnu.ac.kr\\\/blog\\\/documentation-with-markdown\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/bdsl.jbnu.ac.kr\\\/blog\\\/documentation-with-markdown\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/bdsl.jbnu.ac.kr\\\/blog\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction to Markdown for BDSL Laboratory\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/bdsl.jbnu.ac.kr\\\/blog\\\/#website\",\"url\":\"https:\\\/\\\/bdsl.jbnu.ac.kr\\\/blog\\\/\",\"name\":\"Biomedical Data Science Laboratory\",\"description\":\"Home page for Biomedical Data Science Laboratory.\",\"publisher\":{\"@id\":\"https:\\\/\\\/bdsl.jbnu.ac.kr\\\/blog\\\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/bdsl.jbnu.ac.kr\\\/blog\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/bdsl.jbnu.ac.kr\\\/blog\\\/#organization\",\"name\":\"Biomedical Data Science Laboratory\",\"url\":\"https:\\\/\\\/bdsl.jbnu.ac.kr\\\/blog\\\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/bdsl.jbnu.ac.kr\\\/blog\\\/#\\\/schema\\\/logo\\\/image\\\/\",\"url\":\"https:\\\/\\\/bdsl.jbnu.ac.kr\\\/blog\\\/wp-content\\\/uploads\\\/2022\\\/11\\\/logo.png\",\"contentUrl\":\"https:\\\/\\\/bdsl.jbnu.ac.kr\\\/blog\\\/wp-content\\\/uploads\\\/2022\\\/11\\\/logo.png\",\"width\":1792,\"height\":638,\"caption\":\"Biomedical Data Science Laboratory\"},\"image\":{\"@id\":\"https:\\\/\\\/bdsl.jbnu.ac.kr\\\/blog\\\/#\\\/schema\\\/logo\\\/image\\\/\"}},{\"@type\":\"Person\",\"@id\":\"https:\\\/\\\/bdsl.jbnu.ac.kr\\\/blog\\\/#\\\/schema\\\/person\\\/8d22f775fcc218b1184ec0d890034e9b\",\"name\":\"sphong\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/bdsl.jbnu.ac.kr\\\/blog\\\/wp-content\\\/uploads\\\/2022\\\/04\\\/cropped-\uc99d\uba85\uc0ac\uc9c4-96x96.jpg\",\"url\":\"https:\\\/\\\/bdsl.jbnu.ac.kr\\\/blog\\\/wp-content\\\/uploads\\\/2022\\\/04\\\/cropped-\uc99d\uba85\uc0ac\uc9c4-96x96.jpg\",\"contentUrl\":\"https:\\\/\\\/bdsl.jbnu.ac.kr\\\/blog\\\/wp-content\\\/uploads\\\/2022\\\/04\\\/cropped-\uc99d\uba85\uc0ac\uc9c4-96x96.jpg\",\"caption\":\"sphong\"},\"description\":\"Assistant professor Department of Molecular Biology Jeonbuk National University\",\"sameAs\":[\"https:\\\/\\\/bdsl.jbnu.ac.kr\"],\"url\":\"https:\\\/\\\/bdsl.jbnu.ac.kr\\\/blog\\\/author\\\/sphong\\\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Introduction to Markdown for BDSL Laboratory - Biomedical Data Science Laboratory","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/bdsl.jbnu.ac.kr\/blog\/documentation-with-markdown\/","og_locale":"en_US","og_type":"article","og_title":"Introduction to Markdown for BDSL Laboratory - Biomedical Data Science Laboratory","og_description":"(*) This document was generated by ChatGPT based on an outline prepared for the &#8220;Markdown for BDSL Laboratory&#8221; guide. Introduction Markdown is a lightweight markup language for creating structured documents using plain text. Instead of focusing on the visual appearance of a document, Markdown describes its logical structure through a simple and intuitive syntax. Common [&hellip;]","og_url":"https:\/\/bdsl.jbnu.ac.kr\/blog\/documentation-with-markdown\/","og_site_name":"Biomedical Data Science Laboratory","article_published_time":"2026-07-08T05:42:20+00:00","article_modified_time":"2026-08-03T09:15:33+00:00","author":"sphong","twitter_card":"summary_large_image","twitter_misc":{"Written by":"sphong","Est. reading time":"6 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/bdsl.jbnu.ac.kr\/blog\/documentation-with-markdown\/#article","isPartOf":{"@id":"https:\/\/bdsl.jbnu.ac.kr\/blog\/documentation-with-markdown\/"},"author":{"name":"sphong","@id":"https:\/\/bdsl.jbnu.ac.kr\/blog\/#\/schema\/person\/8d22f775fcc218b1184ec0d890034e9b"},"headline":"Introduction to Markdown for BDSL Laboratory","datePublished":"2026-07-08T05:42:20+00:00","dateModified":"2026-08-03T09:15:33+00:00","mainEntityOfPage":{"@id":"https:\/\/bdsl.jbnu.ac.kr\/blog\/documentation-with-markdown\/"},"wordCount":1084,"commentCount":0,"publisher":{"@id":"https:\/\/bdsl.jbnu.ac.kr\/blog\/#organization"},"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/bdsl.jbnu.ac.kr\/blog\/documentation-with-markdown\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/bdsl.jbnu.ac.kr\/blog\/documentation-with-markdown\/","url":"https:\/\/bdsl.jbnu.ac.kr\/blog\/documentation-with-markdown\/","name":"Introduction to Markdown for BDSL Laboratory - Biomedical Data Science Laboratory","isPartOf":{"@id":"https:\/\/bdsl.jbnu.ac.kr\/blog\/#website"},"datePublished":"2026-07-08T05:42:20+00:00","dateModified":"2026-08-03T09:15:33+00:00","breadcrumb":{"@id":"https:\/\/bdsl.jbnu.ac.kr\/blog\/documentation-with-markdown\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/bdsl.jbnu.ac.kr\/blog\/documentation-with-markdown\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/bdsl.jbnu.ac.kr\/blog\/documentation-with-markdown\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/bdsl.jbnu.ac.kr\/blog\/"},{"@type":"ListItem","position":2,"name":"Introduction to Markdown for BDSL Laboratory"}]},{"@type":"WebSite","@id":"https:\/\/bdsl.jbnu.ac.kr\/blog\/#website","url":"https:\/\/bdsl.jbnu.ac.kr\/blog\/","name":"Biomedical Data Science Laboratory","description":"Home page for Biomedical Data Science Laboratory.","publisher":{"@id":"https:\/\/bdsl.jbnu.ac.kr\/blog\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/bdsl.jbnu.ac.kr\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/bdsl.jbnu.ac.kr\/blog\/#organization","name":"Biomedical Data Science Laboratory","url":"https:\/\/bdsl.jbnu.ac.kr\/blog\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/bdsl.jbnu.ac.kr\/blog\/#\/schema\/logo\/image\/","url":"https:\/\/bdsl.jbnu.ac.kr\/blog\/wp-content\/uploads\/2022\/11\/logo.png","contentUrl":"https:\/\/bdsl.jbnu.ac.kr\/blog\/wp-content\/uploads\/2022\/11\/logo.png","width":1792,"height":638,"caption":"Biomedical Data Science Laboratory"},"image":{"@id":"https:\/\/bdsl.jbnu.ac.kr\/blog\/#\/schema\/logo\/image\/"}},{"@type":"Person","@id":"https:\/\/bdsl.jbnu.ac.kr\/blog\/#\/schema\/person\/8d22f775fcc218b1184ec0d890034e9b","name":"sphong","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/bdsl.jbnu.ac.kr\/blog\/wp-content\/uploads\/2022\/04\/cropped-\uc99d\uba85\uc0ac\uc9c4-96x96.jpg","url":"https:\/\/bdsl.jbnu.ac.kr\/blog\/wp-content\/uploads\/2022\/04\/cropped-\uc99d\uba85\uc0ac\uc9c4-96x96.jpg","contentUrl":"https:\/\/bdsl.jbnu.ac.kr\/blog\/wp-content\/uploads\/2022\/04\/cropped-\uc99d\uba85\uc0ac\uc9c4-96x96.jpg","caption":"sphong"},"description":"Assistant professor Department of Molecular Biology Jeonbuk National University","sameAs":["https:\/\/bdsl.jbnu.ac.kr"],"url":"https:\/\/bdsl.jbnu.ac.kr\/blog\/author\/sphong\/"}]}},"uagb_featured_image_src":{"full":false,"thumbnail":false,"medium":false,"medium_large":false,"large":false,"1536x1536":false,"2048x2048":false},"uagb_author_info":{"display_name":"sphong","author_link":"https:\/\/bdsl.jbnu.ac.kr\/blog\/author\/sphong\/"},"uagb_comment_info":0,"uagb_excerpt":"(*) This document was generated by ChatGPT based on an outline prepared for the &#8220;Markdown for BDSL Laboratory&#8221; guide. Introduction Markdown is a lightweight markup language for creating structured documents using plain text. Instead of focusing on the visual appearance of a document, Markdown describes its logical structure through a simple and intuitive syntax. Common&hellip;","_links":{"self":[{"href":"https:\/\/bdsl.jbnu.ac.kr\/blog\/wp-json\/wp\/v2\/posts\/4764","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/bdsl.jbnu.ac.kr\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/bdsl.jbnu.ac.kr\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/bdsl.jbnu.ac.kr\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/bdsl.jbnu.ac.kr\/blog\/wp-json\/wp\/v2\/comments?post=4764"}],"version-history":[{"count":7,"href":"https:\/\/bdsl.jbnu.ac.kr\/blog\/wp-json\/wp\/v2\/posts\/4764\/revisions"}],"predecessor-version":[{"id":4839,"href":"https:\/\/bdsl.jbnu.ac.kr\/blog\/wp-json\/wp\/v2\/posts\/4764\/revisions\/4839"}],"wp:attachment":[{"href":"https:\/\/bdsl.jbnu.ac.kr\/blog\/wp-json\/wp\/v2\/media?parent=4764"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/bdsl.jbnu.ac.kr\/blog\/wp-json\/wp\/v2\/categories?post=4764"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/bdsl.jbnu.ac.kr\/blog\/wp-json\/wp\/v2\/tags?post=4764"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}