Readme: complete rewrite

This commit is contained in:
Akemi Izuko 2023-12-26 22:09:20 -07:00
parent d7685833d4
commit 38d74df89b
Signed by: akemi
GPG key ID: 8DE0764E1809E9FC

101
README.md
View file

@ -1,68 +1,39 @@
# Astro Starter Kit: Blog
# My Personal Website!
```sh
npm create astro@latest -- --template blog
The codebase for my personal website, which you can [visit
here](https://dev.noway.moe)!
Written using [Astro.js](https://astro.build/) as the main framework, with
[Tailwind CSS](https://tailwindcss.com/) for css.
MDX rendering and syntax highlighting provided by [remark.js](https://github.com/remarkjs).
### Licence
Feel free to fork this code and use it for your website! No need to credit me.
This code is licensed under AGPL, meaning that if you do fork this code, you
must also make your fork code open source. That way everyone can benefit from
our collective efforts!
### Building
If you're interested in building this code, do the following:
```bash
git clone https://git.mami2.moe/akemi/noway.moe
cd noway.moe
npm install
npm run dev
# To view the compiled version
npm run preview
# Once you're ready to publish
npm run build
```
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/blog)
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/blog)
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/blog/devcontainer.json)
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
![blog](https://github.com/withastro/astro/assets/2244813/ff10799f-a816-4703-b967-c78997e8323d)
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:
```text
├── 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](https://docs.astro.build/en/guides/content-collections/) to learn more.
Any static assets, like images, can be placed in the `public/` directory.
## 🧞 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](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
## Credit
This theme is based off of the lovely [Bear Blog](https://github.com/HermanMartinus/bearblog/).
I use [Cloudflare Pages](https://pages.cloudflare.com) for hosting. It's free
for static sites, but there are many other options to consider including
[Vercel](https://vercel.com/), [Github](https://pages.github.com), and
[Netlify](https://www.netlify.com) all of which are also free and fast for
static webpages! Live on the edge, pick one you haven't tried!