Skip to content

Commit

Permalink
blog: make some small metadata changes
Browse files Browse the repository at this point in the history
  • Loading branch information
youwen5 committed Apr 25, 2024
1 parent 398cbae commit d123a39
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 11 deletions.
6 changes: 6 additions & 0 deletions .mdlintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"ignore": [
"MD013",
"MD041"
]
}
31 changes: 22 additions & 9 deletions blog/2024/test-post/content.md → blog/2024/first-post/content.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,13 @@ Welcome! This blog is powered by a custom static site generator I made using Sve
on upgrades ([see: lorelei](https://github.com/couscousdude/lorelei)), but in the meantime, check
this out:

> [!NOTE] GitHub-style notifications!
<!-- prettier-ignore -->
> [!NOTE]
> GitHub-style notifications!
> [!TIP] The full Commonmark spec is supported, and it's extended by the GFM spec
<!-- prettier-ignore -->
> [!TIP]
> The full Commonmark spec is supported, and it's extended by the GFM spec
## Tables!

Expand Down Expand Up @@ -34,13 +38,17 @@ Additional metadata is attached to each post via a `TOML` file, the Rustacean wa

```toml
#:schema ../../../post.schema.json
title = "Test Post"
title = "First Post"

[manifest]
date = 2024-04-12T20:48:40.799Z
authors = ["Youwen Wu"]
blurb = "A display of all the blog's rendering capabilities!"
description = "A blog post to test all of the rendering capabilities, with remarks on the side."
description = """
This is the first post on my blog, The Coredump! I'll be writing about all sorts of things here.
This site, including all of the posts, are entirely statically generated from Markdown files, with the static generation
feature of SvelteKit and custom logic implemented by me.
"""
type = "article"
highlight = true

Expand All @@ -51,7 +59,7 @@ secondary = ["blog", "placeholder"]
[cover]
src = "https://images.unsplash.com/photo-1712230879699-e8a0a389da63?q=80&w=3132&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D"
alt = "A beautiful landscape"
caption = "This is the first post!"
caption = "This is the first post! (image courtesy of unsplash)"
```

Code highlighting is also supported, via `highlight.js`.
Expand All @@ -72,9 +80,13 @@ Welcome! This blog is powered by a custom static site generator I made using Sve
on upgrades ([see: lorelei](https://github.com/couscousdude/lorelei)), but in the meantime, check
this out:

> [!NOTE] GitHub-style notifications!
<!-- prettier-ignore -->
> [!NOTE]
> GitHub-style notifications!

> [!TIP] The full Commonmark spec is supported, and it's extended by the GFM spec
<!-- prettier-ignore -->
> [!TIP]
> The full Commonmark spec is supported, and it's extended by the GFM spec

## Tables!

Expand Down Expand Up @@ -129,8 +141,9 @@ The `unified` plugin ecosystem is used to transform markdown into the HTML in th
out the parser
[here](https://github.com/couscousdude/coredump/blob/main/src/lib/utils/parseMarkdown.ts). It
handles all the parsing server-side at build time, so these posts are a collection of mostly static
HTML. The formatting is done mostly with a
[custom stylesheet](https://github.com/couscousdude/coredump/blob/main/src/lib/styles/markdown.pcss).
HTML. Basically, the Markdown files are transformed by `remark` and `rehype` into equivalent HTML,
and then styled with a
[custom CSS stylesheet](https://github.com/couscousdude/coredump/blob/main/src/lib/styles/markdown.pcss).

```
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
#:schema ../../../post.schema.json
title = "Test Post"
title = "First Post"

[manifest]
date = 2024-04-12T20:48:40.799Z
authors = ["Youwen Wu"]
blurb = "A display of all the blog's rendering capabilities!"
description = "A blog post to test all of the rendering capabilities, with remarks on the side."
description = """
This is the first post on my blog, The Coredump! I'll be writing about all sorts of things here.
This site, including all of the posts, are entirely statically generated from Markdown files, with the static generation
feature of SvelteKit and custom logic implemented by me.
"""
type = "article"
highlight = true

Expand Down

1 comment on commit d123a39

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@check-spelling-bot Report

🔴 Please review

See the 📜action log or 📝 job summary for details.

Unrecognized words (1)

mdlintrc

To accept these unrecognized words as correct, you could run the following commands

... in a clone of the [email protected]:couscousdude/coredump.git repository
on the main branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/main/apply.pl' |
perl - 'https://github.com/couscousdude/coredump/actions/runs/8829061656/attempts/1'
Available 📚 dictionaries could cover words (expected and unrecognized) not in the 📘 dictionary

This includes both expected items (211) from .github/actions/spelling/expect.txt and unrecognized words (1)

Dictionary Entries Covers Uniquely
cspell:cryptocurrencies/cryptocurrencies.txt 125 1 1
cspell:ruby/dict/ruby.txt 157 1 1

Consider adding them (in .github/workflows/spelling.yml) for uses: check-spelling/check-spelling@main in its with:

      with:
        extra_dictionaries:
          cspell:cryptocurrencies/cryptocurrencies.txt
          cspell:ruby/dict/ruby.txt

To stop checking additional dictionaries, add (in .github/workflows/spelling.yml) for uses: check-spelling/check-spelling@main in its with:

check_extra_dictionaries: ''
Errors (1)

See the 📜action log or 📝 job summary for details.

❌ Errors Count
❌ check-file-path 1

See ❌ Event descriptions for more information.

Please sign in to comment.