val-town / val-town-blog Goto Github PK

Val Town Blog

JavaScript 2.25% TypeScript 1.07% CSS 4.20% Astro 23.34% HTML 0.51% MDX 68.62%

val-town-blog's Introduction

Val Town Blog

npm create astro@latest -- --template blog

🧑‍🚀 Seasoned astronaut? Delete this file. Have fun!

Features:

✅ Minimal styling (make it your own!)
✅ 100/100 Lighthouse performance
✅ SEO-friendly with canonical URLs and OpenGraph data
✅ Sitemap support
✅ RSS Feed support
✅ Markdown & MDX support

🚀 Project Structure

Inside of your Astro project, you'll see the following folders and files:

├── public/
├── src/
│   ├── components/
│   ├── content/
│   ├── layouts/
│   └── pages/
├── astro.config.mjs
├── README.md
├── package.json
└── tsconfig.json

Astro looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.

There's nothing special about src/components/, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.

The src/content/ directory contains "collections" of related Markdown and MDX documents. Use getCollection() to retrieve posts from src/content/blog/, and type-check your frontmatter using an optional schema. See Astro's Content Collections docs to learn more.

Any static assets, like images, can be placed in the public/ directory.

📦 Git LFS

Make sure you have git lfs (brew install git-lfs) installed before cloning. If you get errors when building you might be working with LFS references instead of downloaded images. Install git-lfs and re-clone the repo.

🧞 Commands

All commands are run from the root of the project, from a terminal:

Command	Action
`npm install`	Installs dependencies
`npm run dev`	Starts local dev server at `localhost:4321`
`npm run build`	Build your production site to `./dist/`
`npm run preview`	Preview your build locally, before deploying
`npm run astro ...`	Run CLI commands like `astro add`, `astro check`
`npm run astro -- --help`	Get help using the Astro CLI

👀 Want to learn more?

Check out our documentation or jump into our Discord server.

Credit

This theme is based off of the lovely Bear Blog.

Private fork development

If you're a Val Town employee, working on a super secret blog post, here's how to develop on this repo in secret:

git lfs install
Create a new branch off the main of this public blog repo git checkout -b super-secret-branch
Add the private fork as a remote: git remote add private https://github.com/val-town/private-blog.git
Push the new branch to the private fork: git push private super-secret-branch
Develop in secret on the private fork
When you're ready to publish, create a public remote on the private repo: git remote add public https://github.com/val-town/val-town-blog.git
Push the branch to the public repo: git push public super-secret-branch
Open a PR from the public repo to the main branch of the public blog repo

val-town-blog's People

Contributors

Stargazers

Watchers

Forkers

xkonti neverstew

val-town-blog's Issues

Update social image default (or remove it)

Make the first blog in the list have the same visual treatment as the rest

Personally I don't like extra featuring the first one in the list

Add a form to subscribe by email

We had this before, powered by sendgrid, but it was pretty clunk. We could make a new component and hit the sendgrid api with it, or proxy it with Val Town.

Better default styling for tables in blog posts

This looks pretty bad!

Remove ViewTransition

It's doing more harm than good - it makes navigations look weird.

Configure domain (for sitemap)

Our site map is pointing to example.com here: https://blog.val.town/sitemap-index.xml

Implement the "Open in Val Town" button from docs repo

In the docs repo there is the "Open in Val Town" component that displays the said button for code blocks. It should be reimplemented in the blog repo or extracted into a separate OSS reusable component.

Use groups for dependabot updates

Annoying to get multiple @astrojs updates! Use groups.

Update link scheme

Looks like our blog links currently look like:

blog.val.town/blog/:slug

But from looking into our posts on hacker news, it used to be blog.val.town/:slug, we should remove the /blog/ to not break old links. And to avoid having "blog" in two places in the URL.

Report on Discord:
https://discord.com/channels/1020432421243592714/1190046447064842261/1190046447064842261

It would be awesome to redirect /blog/:slug to /:slug, just in case we shared links with the new scheme.

generating optimized images
16:06:30   ▶ /_astro/untitled-1.TT4nkGxv_Z2rFvbz.webp (before: 107kB, after: 15kB) (+30ms) (1/101)
16:06:30   ▶ /_astro/screenshot_2023-11-28_at_1024522x.NmWuJ3HQ_Jkm9g.webp (before: 60kB, after: 17kB) (+60ms) (2/101)
16:06:30   ▶ /_astro/untitled.u6f8TGc5_ZlvI9d.webp (before: 89kB, after: 34kB) (+64ms) (3/101)
16:06:30   ▶ /_astro/screenshot_2023-10-19_at_123546.TSYjGZtS_Z14riFn.webp (before: 53kB, after: 25kB) (+54ms) (4/101)
16:06:30   ▶ /_astro/screenshot_2023-11-28_at_1029372x.5c_ENIgY_29hnCi.webp (before: 104kB, after: 40kB) (+157ms) (5/101)
16:06:30   ▶ /_astro/screenshot_2023-10-02_at_160105.ZjKIWbso_2oVpEw.webp (before: 83kB, after: 38kB) (+45ms) (6/101)
16:06:30   ▶ /_astro/frame_1.G23pLodK_1l8Gb9.webp (before: 101kB, after: 54kB) (+48ms) (7/101)
node:internal/process/promises:288
            triggerUncaughtException(err, true /* fromPromise */);
            ^

[Error: Input image exceeds pixel limit]

Annoying that Astro doesn't report the image name!

val-town / val-town-blog Goto Github PK

val-town-blog's Introduction

Val Town Blog

🚀 Project Structure

📦 Git LFS

🧞 Commands

👀 Want to learn more?

Credit

Private fork development

val-town-blog's People

Contributors

Stargazers

Watchers

Forkers

val-town-blog's Issues

Recommend Projects

Recommend Topics

Recommend Org