person_blog
Go to file
saicaca 03f1431b26 doc: update README 2023-10-18 02:34:18 +08:00
public feat: initial commit 2023-10-18 02:15:21 +08:00
src feat: minor style fixes 2023-10-18 02:15:31 +08:00
.gitignore feat: initial commit 2023-10-18 02:15:21 +08:00
README.md doc: update README 2023-10-18 02:34:18 +08:00
astro.config.mjs feat: initial commit 2023-10-18 02:15:21 +08:00
package-lock.json feat: initial commit 2023-10-18 02:15:21 +08:00
package.json feat: sticky navbar and sidebar, minor fixes 2023-10-18 02:15:29 +08:00
pnpm-lock.yaml feat: sticky navbar and sidebar, minor fixes 2023-10-18 02:15:29 +08:00
tailwind.config.cjs feat: initial commit 2023-10-18 02:15:21 +08:00
tsconfig.json feat: post styles, next/prev post btn, display-settings, etc. 2023-10-18 02:15:23 +08:00
vercel.json feat: initial commit 2023-10-18 02:15:21 +08:00
vivia.config.yml feat: i18n, page title 2023-10-18 02:15:25 +08:00

README.md

Fuwari

[!WARNING] This project is still very unfinished and the code is quite messy.

Fuwari (not the final name maybe) is a static blog template built with Astro, a refactored version of hexo-theme-vivia.

🖥️Live Demo (Vercel)

Features (Compared to the Hexo Version)

🚀 Project Structure

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

/
├── public/
│   └── favicon.svg
├── src/
│   ├── components/
│   │   └── Card.astro
│   ├── layouts/
│   │   └── Layout.astro
│   └── pages/
│       └── index.astro
└── package.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.

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:3000
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?

Feel free to check our documentation or jump into our Discord server.