GitHub Markdown CSS 样式库教程

郑眉允Well-Born

于 2024-08-10 07:12:36 发布

阅读量380

点赞数 4

本文链接：https://blog.csdn.net/gitblog_01174/article/details/141076397

版权

GitHub Markdown CSS 样式库教程

markdown-cssCSS for making regular HTML look like plain-text markdown.项目地址:https://gitcode.com/gh_mirrors/ma/markdown-css

1. 项目介绍

markdown-css 是一个由 Mrcoles 开发的开源项目，旨在提供一组样式表，用于使得渲染后的纯文本 Markdown 或 HTML 看起来更加美观。该项目提供了多种风格的主题，包括 Splendor、Retro 和 Air 等，模仿了 GitHub 自己的 Markdown 样式。这些 CSS 文件可以轻松集成到你的网站或应用中，使 Markdown 内容展示更专业。

2. 项目快速启动

安装

使用 CDN

在你的 HTML 文档头部添加以下链接来引入 github-markdown.css：

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/github-markdown-css@latest/github-markdown.min.css">

使用 NPM

首先确保 Node.js 和 npm 已安装，然后运行以下命令进行安装：

npm install github-markdown-css

集成与使用

为了使 Markdown 效果生效，你需要给 Markdown 的容器添加 markdown-body 类，并设置合适的宽度。以下是一个简单的例子：

<!DOCTYPE html>
<html lang="zh">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <link rel="stylesheet" href="github-markdown.min.css">
  <style>
    .markdown-body {
      box-sizing: border-box;
      min-width: 200px;
      max-width: 980px;
      margin: 0 auto;
      padding: 45px;
    }

    @media (max-width: 767px) {
      .markdown-body {
        padding: 15px;
      }
    }
  </style>
</head>
<body>
  <article class="markdown-body">
    <!-- 这里放置你的 Markdown 内容 -->
    <h1>测试标题</h1>
    <p>这是你的测试内容。</p>
  </article>
</body>
</html>