mirror of
https://github.com/kuohuanhuan/x-markdown-css.git
synced 2024-11-25 06:18:19 +00:00
Compare commits
4 Commits
2b9619f2e2
...
df63212d6d
Author | SHA1 | Date | |
---|---|---|---|
df63212d6d
|
|||
ee89b96068
|
|||
63a6fc2072
|
|||
e54282e5f8
|
4
.github/workflows/release.yml
vendored
4
.github/workflows/release.yml
vendored
@ -8,8 +8,8 @@ on:
|
||||
jobs:
|
||||
# NPM Registry & GitHub Release
|
||||
release:
|
||||
# Use Ubuntu 22.04 LTS
|
||||
runs-on: ubuntu-22.04
|
||||
# Use Windows Server 2022
|
||||
runs-on: windows-2022
|
||||
steps:
|
||||
# Step I
|
||||
- name: Get Source Code
|
||||
|
30
README.md
30
README.md
@ -14,35 +14,9 @@
|
||||
|
||||
According to [.browserslistrc](https://github.com/kuohuanhuan/x-markdown-css/blob/master/.browserslistrc), `x-markdown-css` supports **all browsers support CSS variables.**
|
||||
|
||||
## Usage
|
||||
## Get Started
|
||||
|
||||
You can use `x-markdown-css` with:
|
||||
|
||||
1. A CDN service:
|
||||
|
||||
- UNPKG: `https://unpkg.com/x-markdown-css@latest`
|
||||
- jsDelivr: `https://fastly.jsdelivr.net/npm/x-markdown-css@latest`
|
||||
- CDNJS: *Coming soon. **Waiting for you to make `x-markdown-css` [popular enough](https://github.com/cdnjs/packages/blob/master/CONTRIBUTING.md#policy-rules-and-guidelines)**!*
|
||||
|
||||
2. A CSS (with Node.js) / Sass / SCSS project:
|
||||
|
||||
First, install it with NPM ([PNPM](https://pnpm.io) or [Yarn](https://yarnpkg.com) also works):
|
||||
|
||||
```sh
|
||||
npm i x-markdown-css@latest
|
||||
```
|
||||
|
||||
Then, add it to your `.css` / `.sass` / `.scss` file.
|
||||
|
||||
For example, in CSS / SCSS you do:
|
||||
|
||||
```css
|
||||
@import 'x-markdown-css';
|
||||
```
|
||||
|
||||
> *ps. Note that no path or file extention is required
|
||||
> since the `style` and `sass` field in `package.json` is filled.
|
||||
> Just simply use `'x-markdown-css'` to import it.*
|
||||
Visit the [Wiki](https://github.com/kuohuanhuan/x-markdown-css/wiki) page for more information.
|
||||
|
||||
## Built with
|
||||
|
||||
|
@ -2,7 +2,7 @@
|
||||
|
||||
@use 'partials/container';
|
||||
|
||||
.prose {
|
||||
.markdown-body {
|
||||
@include container.container;
|
||||
@include meta.load-css('partials/all');
|
||||
}
|
@ -14,6 +14,7 @@
|
||||
--xm-c-#{$name}: #{$val};
|
||||
}
|
||||
}
|
||||
|
||||
.markdown-body {
|
||||
@each $name, $val in meta.module-variables('light') {
|
||||
--xm-c-#{$name}: #{$val};
|
@ -1,4 +1,2 @@
|
||||
@use 'scss/vars';
|
||||
|
||||
@use 'scss/markdown';
|
||||
@use 'scss/prose';
|
||||
@use 'vars';
|
||||
@use 'content';
|
||||
|
@ -2,5 +2,9 @@
|
||||
max-width: fit-content;
|
||||
color: var(--xm-c-regular);
|
||||
font-size: 1rem;
|
||||
font-family: var(--xm-font-display) !important;
|
||||
line-height: 1.75;
|
||||
&:first-child {
|
||||
margin-top: 1rem;
|
||||
}
|
||||
}
|
@ -33,3 +33,9 @@ pre {
|
||||
}
|
||||
}
|
||||
}
|
||||
.shiki {
|
||||
margin: .5rem 0;
|
||||
font-size: 1.05rem;
|
||||
font-family: var(--xm-font-code) !important;
|
||||
line-height: 1.4;
|
||||
}
|
13
src/partials/link.scss
Normal file
13
src/partials/link.scss
Normal file
@ -0,0 +1,13 @@
|
||||
a {
|
||||
border-bottom: 1px solid var(--xm-c-link-border);
|
||||
color: var(--xm-c-deeper);
|
||||
font-weight: 500;
|
||||
text-decoration: none;
|
||||
transition: border .3s ease-in-out;
|
||||
code {
|
||||
color: var(--xm-c-code);
|
||||
}
|
||||
&:hover {
|
||||
border-bottom: 1px solid var(--xm-c-regular);
|
||||
}
|
||||
}
|
@ -1,5 +1,6 @@
|
||||
img,
|
||||
video {
|
||||
width: 100%;
|
||||
margin-top: 2rem;
|
||||
margin-bottom: 2rem;
|
||||
}
|
@ -2,12 +2,14 @@ blockquote,
|
||||
q {
|
||||
margin-top: 1.65rem;
|
||||
margin-bottom: 1.65rem;
|
||||
padding-left: 1rem;
|
||||
padding: .6rem 1.2rem;
|
||||
border-left: .25rem solid var(--xm-c-quote-border);
|
||||
color: inherit;
|
||||
font-weight: 500;
|
||||
font-style: italic;
|
||||
line-height: 1.5rem;
|
||||
quotes: '\201C''\201D''\2018''\2019';
|
||||
opacity: .8;
|
||||
p {
|
||||
&:first-of-type::before {
|
||||
content: open-quote;
|
||||
@ -16,4 +18,12 @@ q {
|
||||
content: close-quote;
|
||||
}
|
||||
}
|
||||
> * {
|
||||
&:first-child {
|
||||
margin-top: 0;
|
||||
}
|
||||
&:last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
}
|
||||
}
|
@ -55,10 +55,35 @@ h6 {
|
||||
opacity: .5;
|
||||
}
|
||||
hr {
|
||||
margin-top: 3rem;
|
||||
margin-bottom: 3rem;
|
||||
width: 50px;
|
||||
margin-top: 2rem;
|
||||
margin-bottom: 2rem;
|
||||
border-color: var(--xm-c-hr-border);
|
||||
+ * {
|
||||
margin-top: 0;
|
||||
}
|
||||
}
|
||||
.header-anchor {
|
||||
float: left;
|
||||
margin-top: .125rem;
|
||||
margin-left: -1.25rem;
|
||||
padding-right: .5rem;
|
||||
border: 0 !important;
|
||||
font-size: .875rem;
|
||||
text-decoration: none;
|
||||
opacity: 0;
|
||||
&:hover,
|
||||
&:focus {
|
||||
text-decoration: none;
|
||||
}
|
||||
}
|
||||
@for $i from 1 through 6 {
|
||||
h#{$i} {
|
||||
&:hover,
|
||||
&:focus {
|
||||
.header-anchor {
|
||||
opacity: .35 + $i * .025;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
@ -1,102 +0,0 @@
|
||||
.markdown-body {
|
||||
color: var(--xm-c-regular);
|
||||
font-family: var(--xm-font-display) !important;
|
||||
pre:not(.shiki) {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
background: transparent;
|
||||
}
|
||||
.shiki {
|
||||
margin: .5rem 0;
|
||||
font-size: 1.05rem;
|
||||
font-family: var(--xm-font-code) !important;
|
||||
line-height: 1.4;
|
||||
&.shiki-light {
|
||||
background: var(--xm-c-shiki-light) !important;
|
||||
}
|
||||
&.shiki-dark {
|
||||
background: var(--xm-c-shiki-dark) !important;
|
||||
}
|
||||
}
|
||||
img {
|
||||
width: 100%;
|
||||
}
|
||||
a {
|
||||
border-bottom: 1px solid var(--xm-c-link-border);
|
||||
font-weight: inherit;
|
||||
text-decoration: none;
|
||||
transition: border .3s ease-in-out;
|
||||
&:hover {
|
||||
border-bottom: 1px solid var(--xm-c-regular);
|
||||
}
|
||||
code {
|
||||
color: inherit;
|
||||
}
|
||||
}
|
||||
hr {
|
||||
width: 50px;
|
||||
margin-top: 2rem;
|
||||
margin-bottom: 2rem;
|
||||
}
|
||||
blockquote,
|
||||
q {
|
||||
padding: .6rem 1.2rem;
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
line-height: 1.5rem;
|
||||
opacity: .8;
|
||||
> * {
|
||||
&:first-child {
|
||||
margin-top: 0;
|
||||
}
|
||||
&:last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
}
|
||||
p:first-of-type {
|
||||
&::before,
|
||||
&::after {
|
||||
content: none;
|
||||
}
|
||||
}
|
||||
}
|
||||
&:first-child {
|
||||
margin-top: 1rem;
|
||||
}
|
||||
}
|
||||
html:not(.dark) .shiki-dark,
|
||||
.dark .shiki-light {
|
||||
display: none;
|
||||
}
|
||||
.item {
|
||||
text-decoration: none;
|
||||
opacity: .6;
|
||||
transition: .2s all ease-out;
|
||||
&:hover {
|
||||
opacity: 1;
|
||||
}
|
||||
}
|
||||
.header-anchor {
|
||||
float: left;
|
||||
margin-top: .125rem;
|
||||
margin-left: -1.25rem;
|
||||
padding-right: .5rem;
|
||||
border: 0 !important;
|
||||
font-size: .875rem;
|
||||
text-decoration: none;
|
||||
opacity: 0;
|
||||
&:hover,
|
||||
&:focus {
|
||||
text-decoration: none;
|
||||
}
|
||||
}
|
||||
@for $i from 1 through 6 {
|
||||
h#{$i} {
|
||||
&:hover,
|
||||
&:focus {
|
||||
.header-anchor {
|
||||
opacity: .35 + $i * .025;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
@ -1,8 +0,0 @@
|
||||
a {
|
||||
color: var(--xm-c-deeper);
|
||||
font-weight: 500;
|
||||
text-decoration: none;
|
||||
code {
|
||||
color: var(--xm-c-code);
|
||||
}
|
||||
}
|
@ -12,7 +12,3 @@ $hr-border: hsla(0deg 0% 50% / .3);
|
||||
$quote-border: hsla(0deg 0% 50% / .3);
|
||||
$thead-border: #d1d5db;
|
||||
$tr-border: #e5e7eb;
|
||||
|
||||
// Shiki (code highlighting)
|
||||
$shiki-light: #f8f8f8;
|
||||
$shiki-dark: #0e0e0e;
|
Reference in New Issue
Block a user