|
1 | | -# 🍥Fuwari |
| 1 | +<p align="center"> |
| 2 | + <h1 align="center">🪨 MarbleStack</h1> |
| 3 | + <p align="center"> |
| 4 | + A personal website and blog for sharing projects, experiments, and technical notes. |
| 5 | + </p> |
| 6 | + <p align="center"> |
| 7 | + 🌐 Live site: <a href="https://marblestack.github.io/marblestack/">https://marblestack.github.io/marblestack/</a> |
| 8 | + </p> |
| 9 | +</p> |
| 10 | + |
2 | 11 |  |
3 | 12 |  |
4 | 13 | [](https://deepwiki.com/saicaca/fuwari) |
5 | 14 | [](https://app.fossa.com/projects/git%2Bgithub.com%2Fsaicaca%2Ffuwari?ref=badge_shield&issueType=license) |
6 | 15 |
|
7 | | -A static blog template built with [Astro](https://astro.build). |
8 | | - |
9 | | -[**🖥️ Live Demo (Vercel)**](https://fuwari.vercel.app) |
10 | | - |
11 | | - |
12 | | - |
13 | | -🌏 README in |
14 | | -[**中文**](https://github.com/saicaca/fuwari/blob/main/docs/README.zh-CN.md) / |
15 | | -[**日本語**](https://github.com/saicaca/fuwari/blob/main/docs/README.ja.md) / |
16 | | -[**한국어**](https://github.com/saicaca/fuwari/blob/main/docs/README.ko.md) / |
17 | | -[**Español**](https://github.com/saicaca/fuwari/blob/main/docs/README.es.md) / |
18 | | -[**ไทย**](https://github.com/saicaca/fuwari/blob/main/docs/README.th.md) / |
19 | | -[**Tiếng Việt**](https://github.com/saicaca/fuwari/blob/main/docs/README.vi.md) / |
20 | | -[**Bahasa Indonesia**](https://github.com/saicaca/fuwari/blob/main/docs/README.id.md) (Provided by the community and may not always be up-to-date) |
21 | | - |
22 | | -## ✨ Features |
23 | | - |
24 | | -- [x] Built with [Astro](https://astro.build) and [Tailwind CSS](https://tailwindcss.com) |
25 | | -- [x] Smooth animations and page transitions |
26 | | -- [x] Light / dark mode |
27 | | -- [x] Customizable theme colors & banner |
28 | | -- [x] Responsive design |
29 | | -- [x] Search functionality with [Pagefind](https://pagefind.app/) |
30 | | -- [x] [Markdown extended features](https://github.com/saicaca/fuwari?tab=readme-ov-file#-markdown-extended-syntax) |
31 | | -- [x] Table of contents |
32 | | -- [x] RSS feed |
33 | | - |
34 | | -## 🚀 Getting Started |
35 | | - |
36 | | -1. Create your blog repository: |
37 | | - - [Generate a new repository](https://github.com/saicaca/fuwari/generate) from this template or fork this repository. |
38 | | - - Or run one of the following commands: |
39 | | - ```sh |
40 | | - npm create fuwari@latest |
41 | | - yarn create fuwari |
42 | | - pnpm create fuwari@latest |
43 | | - bun create fuwari@latest |
44 | | - deno run -A npm:create-fuwari@latest |
45 | | - ``` |
46 | | -2. To edit your blog locally, clone your repository, run `pnpm install` to install dependencies. |
47 | | - - Install [pnpm](https://pnpm.io) `npm install -g pnpm` if you haven't. |
48 | | -3. Edit the config file `src/config.ts` to customize your blog. |
49 | | -4. Run `pnpm new-post <filename>` to create a new post and edit it in `src/content/posts/`. |
50 | | -5. Deploy your blog to Vercel, Netlify, GitHub Pages, etc. following [the guides](https://docs.astro.build/en/guides/deploy/). You need to edit the site configuration in `astro.config.mjs` before deployment. |
51 | | -
|
52 | | -## 📝 Frontmatter of Posts |
53 | | -
|
54 | | -```yaml |
| 16 | +## ✨ Overview |
| 17 | + |
| 18 | +**MarbleStack** is my personal website and blog focused on documenting ideas, side projects, tutorials, and creative experiments. |
| 19 | + |
| 20 | +It serves as a lightweight knowledge base and a place to archive learnings over time. |
| 21 | + |
| 22 | +The site is designed to be: |
| 23 | +- Simple and fast |
| 24 | +- Easy to maintain |
| 25 | +- Friendly for writing technical and creative content |
| 26 | +- Fully static and easy to deploy |
| 27 | + |
55 | 28 | --- |
56 | | -title: My First Blog Post |
57 | | -published: 2023-09-09 |
58 | | -description: This is the first post of my new Astro blog. |
59 | | -image: ./cover.jpg |
60 | | -tags: [Foo, Bar] |
61 | | -category: Front-end |
62 | | -draft: false |
63 | | -lang: jp # Set only if the post's language differs from the site's language in `config.ts` |
| 29 | + |
| 30 | +## 📚 Content |
| 31 | + |
| 32 | +Typical content includes: |
| 33 | + |
| 34 | +- 🧪 Project logs and experiments |
| 35 | +- 🧑💻 Programming notes and tutorials |
| 36 | +- 🎮 Game development notes |
| 37 | +- ✍️ Personal thoughts and learning summaries |
| 38 | +- 📦 Small tools, demos, and references |
| 39 | + |
| 40 | +Content structure and organization may evolve as the site grows. |
| 41 | + |
64 | 42 | --- |
65 | | -``` |
66 | 43 |
|
67 | | -## 🧩 Markdown Extended Syntax |
| 44 | +## 🚀 Development |
68 | 45 |
|
69 | | -In addition to Astro's default support for [GitHub Flavored Markdown](https://github.github.com/gfm/), several extra Markdown features are included: |
| 46 | +Install dependencies: |
70 | 47 |
|
71 | | -- Admonitions ([Preview and Usage](https://fuwari.vercel.app/posts/markdown-extended/#admonitions)) |
72 | | -- GitHub repository cards ([Preview and Usage](https://fuwari.vercel.app/posts/markdown-extended/#github-repository-cards)) |
73 | | -- Enhanced code blocks with Expressive Code ([Preview](https://fuwari.vercel.app/posts/expressive-code/) / [Docs](https://expressive-code.com/)) |
| 48 | +```bash |
| 49 | +npm install pnpm |
| 50 | +``` |
74 | 51 |
|
75 | | -## ⚡ Commands |
| 52 | +```bash |
| 53 | +pnpm run dev |
| 54 | +``` |
| 55 | + |
| 56 | +## 🌍 Deployment |
76 | 57 |
|
77 | | -All commands are run from the root of the project, from a terminal: |
| 58 | +The site is deployed using GitHub Pages. |
| 59 | +After building, the static output is published automatically through CI. |
78 | 60 |
|
79 | | -| Command | Action | |
80 | | -|:---------------------------|:----------------------------------------------------| |
81 | | -| `pnpm install` | Installs dependencies | |
82 | | -| `pnpm dev` | Starts local dev server at `localhost:4321` | |
83 | | -| `pnpm build` | Build your production site to `./dist/` | |
84 | | -| `pnpm preview` | Preview your build locally, before deploying | |
85 | | -| `pnpm check` | Run checks for errors in your code | |
86 | | -| `pnpm format` | Format your code using Biome | |
87 | | -| `pnpm new-post <filename>` | Create a new post | |
88 | | -| `pnpm astro ...` | Run CLI commands like `astro add`, `astro check` | |
89 | | -| `pnpm astro --help` | Get help using the Astro CLI | |
| 61 | +Live site: |
90 | 62 |
|
91 | | -## ✏️ Contributing |
| 63 | +https://marblestack.github.io/marblestack/ |
92 | 64 |
|
93 | | -Check out the [Contributing Guide](https://github.com/saicaca/fuwari/blob/main/CONTRIBUTING.md) for details on how to contribute to this project. |
94 | 65 |
|
95 | 66 | ## 📄 License |
96 | 67 |
|
97 | 68 | This project is licensed under the MIT License. |
98 | 69 |
|
99 | | -[](https://app.fossa.com/projects/git%2Bgithub.com%2Fsaicaca%2Ffuwari?ref=badge_large&issueType=license) |
| 70 | +## 🙌 Acknowledgements |
| 71 | + |
| 72 | +Built with [Fuwari](https://github.com/saicaca/fuwari.git). |
| 73 | +Thanks to the open-source community for making this possible. |
0 commit comments